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 Foundation
import ServiceStack

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

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

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

    /**
    * The credit card expiration Year
    */
    // @ApiMember(Description="The credit card expiration Year")
    public var expYear:String

    /**
    * The credit card expiration month
    */
    // @ApiMember(Description="The credit card expiration month")
    public var expMonth:String

    /**
    * 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 var ticketId:String

    required public init(){}
}

public class CompanyCreditCardQueryResponse : Codable
{
    /**
    * The credit card id
    */
    // @ApiMember(Description="The credit card id")
    public var id:Int

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

    /**
    * If the credit card is active
    */
    // @ApiMember(Description="If the credit card is active")
    public var active:Bool

    /**
    * If the credit card is valid (active and not expired)
    */
    // @ApiMember(Description="If the credit card is valid (active and not expired)")
    public var isValid:Bool

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

    /**
    * The credit card expiration Year
    */
    // @ApiMember(Description="The credit card expiration Year")
    public var expYear:String

    /**
    * The credit card expiration month
    */
    // @ApiMember(Description="The credit card expiration month")
    public var expMonth:String

    /**
    * 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 var ticketId:String

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

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

    required public init(){}
}


Swift CreateCompanyCreditCard DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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"}