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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	serviceId: 00000000000000000000000000000000,
	productData: 
	{
		00000000000000000000000000000000: 00000000000000000000000000000000
	},
	addonIds: 
	[
		00000000000000000000000000000000
	],
	totalPrice: 0,
	selectedOptions: 
	{
		timeslot: 
		{
			from: -62135596800000,
			to: -62135596800000
		},
		person: 
		{
			numberOfAdults: 0,
			numberOfChildren: 0
		},
		currencyCode: String
	},
	clientType: 1,
	version: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		paymentMethods: String,
		paymentId: 00000000000000000000000000000000,
		price: 0,
		currency: 
		{
			id: 00000000000000000000000000000000,
			name: String,
			code: String,
			symbol: String
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}

Viviot.Api

PaymentMethodsRequest

Allowable Values

HTTP + JSV