Viviot.Api

PaymentMethodsRequest

The following routes are available for this service:
POST	/mobile/payments/getAvailablePaymentMethods	Validates the payment data and returns all available payment methods from integrated payment provider.

**PaymentMethodsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceId	query	string	Yes	Service Id (GUID).
ProductData	body	Dictionary<Guid, Guid>	Yes	List of product Ids along with access template Ids
AddonIds	body	List<Guid>	No	List of selected addon Ids
TotalPrice	query	integer	Yes	Total price of the service.
SelectedOptions	body	SelectedOptionsDto	Yes	Selected options of the reservation/request service
ClientType	query	ClientType	Yes	Type of client initiating the payment methods request. Allowable Values IOS Android Web

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**SelectedOptionsDto** Parameters:
Name	Parameter	Data Type	Required
Timeslot	form	TimeslotDto	No
Person	form	PersonOptionDto	No
CurrencyCode	form	string	No

**TimeslotDto** Parameters:
Name	Parameter	Data Type	Required	Description
From	form	DateTime?	No
To	form	DateTime?	No

**PersonOptionDto** Parameters:
Name	Parameter	Data Type	Required	Description
NumberOfAdults	form	int	No
NumberOfChildren	form	int?	No

**ClientType** Enum:
Name	Value
IOS	1
Android	2
Web	3

**PaymentMethodsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	PaymentMethodsView	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**PaymentMethodsView** Parameters:
Name	Parameter	Data Type	Required
PaymentMethods	form	string	No
PaymentId	form	Guid	No
Price	form	long	No
Currency	form	CurrencyDto	No

**CurrencyDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Code	form	string	No
Symbol	form	string	No

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

<PaymentMethodsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Mobile">
  <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
  <AddonIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </AddonIds>
  <ClientType>IOS</ClientType>
  <ProductData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfguidguid>
      <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
      <d2p1:Value>00000000-0000-0000-0000-000000000000</d2p1:Value>
    </d2p1:KeyValueOfguidguid>
  </ProductData>
  <SelectedOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service.Mobile">
    <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
    <d2p1:Person>
      <d2p1:NumberOfAdults>0</d2p1:NumberOfAdults>
      <d2p1:NumberOfChildren>0</d2p1:NumberOfChildren>
    </d2p1:Person>
    <d2p1:Timeslot xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
      <d3p1:From>0001-01-01T00:00:00</d3p1:From>
      <d3p1:To>0001-01-01T00:00:00</d3p1:To>
    </d2p1:Timeslot>
  </SelectedOptions>
  <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
  <TotalPrice>0</TotalPrice>
</PaymentMethodsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentMethodsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Mobile">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Mobile.Payment">
    <d2p1:Currency xmlns:d3p1="http://schemas.datacontract.org/2004/07/Integrations.Payment.Responses">
      <d3p1:Code>String</d3p1:Code>
      <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
      <d3p1:Name>String</d3p1:Name>
      <d3p1:Symbol>String</d3p1:Symbol>
    </d2p1:Currency>
    <d2p1:PaymentId>00000000-0000-0000-0000-000000000000</d2p1:PaymentId>
    <d2p1:PaymentMethods>String</d2p1:PaymentMethods>
    <d2p1:Price>0</d2p1:Price>
  </Data>
</PaymentMethodsResponse>

Viviot.Api

PaymentMethodsRequest

Allowable Values

HTTP + XML