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 java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CreateCompanyCreditCard : ICompany
{
    /**
    * 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.")
    var CompanyId:UUID? = null

    /**
    * The credit card name
    */
    @ApiMember(Description="The credit card name")
    var Name:String? = null

    /**
    * The credit card type. In example Mastercard, Visa
    */
    @ApiMember(Description="The credit card type. In example Mastercard, Visa")
    var Type:String? = null

    /**
    * The credit card expiration Year
    */
    @ApiMember(Description="The credit card expiration Year")
    var ExpYear:String? = null

    /**
    * The credit card expiration month
    */
    @ApiMember(Description="The credit card expiration month")
    var ExpMonth:String? = null

    /**
    * 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")
    var TicketId:String? = null
}

open class CompanyCreditCardQueryResponse
{
    /**
    * The credit card id
    */
    @ApiMember(Description="The credit card id")
    var Id:Int? = null

    /**
    * The credit card name
    */
    @ApiMember(Description="The credit card name")
    var Name:String? = null

    /**
    * If the credit card is active
    */
    @ApiMember(Description="If the credit card is active")
    var Active:Boolean? = null

    /**
    * If the credit card is valid (active and not expired)
    */
    @ApiMember(Description="If the credit card is valid (active and not expired)")
    var IsValid:Boolean? = null

    /**
    * The credit card type
    */
    @ApiMember(Description="The credit card type")
    var Type:String? = null

    /**
    * The credit card expiration Year
    */
    @ApiMember(Description="The credit card expiration Year")
    var ExpYear:String? = null

    /**
    * The credit card expiration month
    */
    @ApiMember(Description="The credit card expiration month")
    var ExpMonth:String? = null

    /**
    * 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")
    var TicketId:String? = null

    /**
    * The date when the credit card was saved.
    */
    @ApiMember(Description="The date when the credit card was saved.")
    var Created:Date? = null

    /**
    * The date when the credit card was updated.
    */
    @ApiMember(Description="The date when the credit card was updated.")
    var Updated:Date? = null
}

Kotlin 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: testapi.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>