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.
CreateCompanyCreditCard Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
NamebodystringNoThe credit card name
TypebodystringNoThe credit card type. In example Mastercard, Visa
ExpYearbodystringNoThe credit card expiration Year
ExpMonthbodystringNoThe credit card expiration month
TicketIdbodystringNoThe credit card ticket name. This is secret information and won't be displayed
CompanyCreditCardQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe credit card id
NameformstringNoThe credit card name
ActiveformboolNoIf the credit card is active
IsValidformboolNoIf the credit card is valid (active and not expired)
TypeformstringNoThe credit card type
ExpYearformstringNoThe credit card expiration Year
ExpMonthformstringNoThe credit card expiration month
TicketIdformstringNoThe credit card ticket name. This is secret information and won't be displayed
CreatedformDateTime?NoThe date when the credit card was saved.
UpdatedformDateTime?NoThe date when the credit card was updated.

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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/csv
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"}