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.
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 CompanyCreditCardQueryResponse:
    # @ApiMember(Description="The credit card id")
    id: int = 0
    """
    The credit card id
    """


    # @ApiMember(Description="The credit card name")
    name: Optional[str] = None
    """
    The credit card name
    """


    # @ApiMember(Description="If the credit card is active")
    active: bool = False
    """
    If the credit card is active
    """


    # @ApiMember(Description="If the credit card is valid (active and not expired)")
    is_valid: bool = False
    """
    If the credit card is valid (active and not expired)
    """


    # @ApiMember(Description="The credit card type")
    type: Optional[str] = None
    """
    The credit card type
    """


    # @ApiMember(Description="The credit card expiration Year")
    exp_year: Optional[str] = None
    """
    The credit card expiration Year
    """


    # @ApiMember(Description="The credit card expiration month")
    exp_month: Optional[str] = None
    """
    The credit card expiration month
    """


    # @ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")
    ticket_id: Optional[str] = None
    """
    The credit card ticket name. This is secret information and won't be displayed
    """


    # @ApiMember(Description="The date when the credit card was saved.")
    created: Optional[datetime.datetime] = None
    """
    The date when the credit card was saved.
    """


    # @ApiMember(Description="The date when the credit card was updated.")
    updated: Optional[datetime.datetime] = None
    """
    The date when the credit card was updated.
    """


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateCompanyCreditCard(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="The credit card name")
    name: Optional[str] = None
    """
    The credit card name
    """


    # @ApiMember(Description="The credit card type. In example Mastercard, Visa")
    type: Optional[str] = None
    """
    The credit card type. In example Mastercard, Visa
    """


    # @ApiMember(Description="The credit card expiration Year")
    exp_year: Optional[str] = None
    """
    The credit card expiration Year
    """


    # @ApiMember(Description="The credit card expiration month")
    exp_month: Optional[str] = None
    """
    The credit card expiration month
    """


    # @ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")
    ticket_id: Optional[str] = None
    """
    The credit card ticket name. This is secret information and won't be displayed
    """

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