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.

export class CompanyCreditCardQueryResponse
{
    /** @description The credit card id */
    // @ApiMember(Description="The credit card id")
    public Id: number;

    /** @description The credit card name */
    // @ApiMember(Description="The credit card name")
    public Name: string;

    /** @description If the credit card is active */
    // @ApiMember(Description="If the credit card is active")
    public Active: boolean;

    /** @description If the credit card is valid (active and not expired) */
    // @ApiMember(Description="If the credit card is valid (active and not expired)")
    public IsValid: boolean;

    /** @description The credit card type */
    // @ApiMember(Description="The credit card type")
    public Type: string;

    /** @description The credit card expiration Year */
    // @ApiMember(Description="The credit card expiration Year")
    public ExpYear: string;

    /** @description The credit card expiration month */
    // @ApiMember(Description="The credit card expiration month")
    public ExpMonth: string;

    /** @description The credit card ticket name. This is secret information and won't be displayed */
    // @ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")
    public TicketId: string;

    /** @description The date when the credit card was saved. */
    // @ApiMember(Description="The date when the credit card was saved.")
    public Created?: string;

    /** @description The date when the credit card was updated. */
    // @ApiMember(Description="The date when the credit card was updated.")
    public Updated?: string;

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateCompanyCreditCard 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 The credit card name */
    // @ApiMember(Description="The credit card name")
    public Name: string;

    /** @description The credit card type. In example Mastercard, Visa */
    // @ApiMember(Description="The credit card type. In example Mastercard, Visa")
    public Type: string;

    /** @description The credit card expiration Year */
    // @ApiMember(Description="The credit card expiration Year")
    public ExpYear: string;

    /** @description The credit card expiration month */
    // @ApiMember(Description="The credit card expiration month")
    public ExpMonth: string;

    /** @description The credit card ticket name. This is secret information and won't be displayed */
    // @ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")
    public TicketId: string;

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

TypeScript CreateCompanyCreditCard DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Name: String,
	Type: String,
	ExpYear: String,
	ExpMonth: String,
	TicketId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	Active: False,
	IsValid: False,
	Type: String,
	ExpYear: String,
	ExpMonth: String,
	TicketId: String,
	Created: "0001-01-01T00:00:00",
	Updated: "0001-01-01T00:00:00"
}