Viviot.Api

<back to all web services

PaymentMethodsRequest

Requires Authentication
The following routes are available for this service:
POST/mobile/payments/getAvailablePaymentMethodsValidates the payment data and returns all available payment methods from integrated payment provider.
PaymentMethodsRequest Parameters:
NameParameterData TypeRequiredDescription
ServiceIdquerystringYesService Id (GUID).
ProductDatabodyDictionary<Guid, Guid>YesList of product Ids along with access template Ids
AddonIdsbodyList<Guid>NoList of selected addon Ids
TotalPricequeryintegerYesTotal price of the service.
SelectedOptionsbodySelectedOptionsDtoYesSelected options of the reservation/request service
ClientTypequeryClientTypeYesType of client initiating the payment methods request.

Allowable Values

  • IOS
  • Android
  • Web
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
SelectedOptionsDto Parameters:
NameParameterData TypeRequiredDescription
TimeslotformTimeslotDtoNo
PersonformPersonOptionDtoNo
CurrencyCodeformstringNo
TimeslotDto Parameters:
NameParameterData TypeRequiredDescription
FromformDateTime?No
ToformDateTime?No
PersonOptionDto Parameters:
NameParameterData TypeRequiredDescription
NumberOfAdultsformintNo
NumberOfChildrenformint?No
ClientType Enum:
NameValue
IOS1
Android2
Web3
PaymentMethodsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformPaymentMethodsViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PaymentMethodsView Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodsformstringNo
PaymentIdformGuidNo
PriceformlongNo
CurrencyformCurrencyDtoNo
CurrencyDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
CodeformstringNo
SymbolformstringNo

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 /mobile/payments/getAvailablePaymentMethods HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'PaymentMethodsRequest' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'PaymentMethodsResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)