SPS Reservations API

/v1/checkout

POST

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	CheckoutRequest

Responses

Code	Description	Schema
200	A successful response.	CheckoutResponse
default	An unexpected error response.	runtimeError

/v1/confirm

POST

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	CheckoutRequest

Responses

Code	Description	Schema
200	A successful response.	CheckoutResponse
default	An unexpected error response.	runtimeError

/v1/initiate

POST

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	InitiateRequest

Responses

Code	Description	Schema
200	A successful response.	InitiateResponse
default	An unexpected error response.	runtimeError

/v1/session

POST

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	SessionRequest

Responses

Code	Description	Schema
200	A successful response.	InitiateSession
default	An unexpected error response.	runtimeError

Models

ACHAccountType

Name	Type	Description	Required
ACHAccountType	string

APICall

Name	Type	Description	Required
name	string	Unique identifier for this API Call. This identifier can be used as a source in future API calls.	No
host	string		No
path	string		No
verb	Verb		No
headers	[ Header ]		No
body	string		No
replacements	[ Replacement ]		No
errorField	Replacement		No
protocol	string		No

AcceptedCards

Name	Type	Description	Required
AcceptedCards	string

Address

Name	Type	Description	Required
firstName	string		No
lastName	string		No
phone	string		No
address1	string		No
address2	string		No
city	string		No
province	string		No
postalCode	string		No
country	string		No
email	string		No
secondaryPhone	string		No

Branding

Name	Type	Description	Required
primaryCode	string		No
secondaryColor	string		No
headerImageURL	string	need to define some reasonable bounds for resolution and aspect ratio.	No
headerImageAltText	string		No
pageTitle	string		No
phoneNumber	string		No
email	string		No
confirmButtonText	string		No
headerInfoText	string		No
footerText	string		No
closureText	string		No

CallError

Name	Type	Description	Required
name	string		No
url	string		No
code	integer		No
error	string		No

CallGroup

Name	Type	Description	Required
type	CallGroupType		No
failure_mode	FailOn		No
calls	[ APICall ]		No
paymentType	PaymentType		No

CallGroupType

Name	Type	Description	Required
CallGroupType	string

CheckoutRequest

Name	Type	Description	Required
token	string		No
cardHolderName	string		No
cardNumber	string		No
expMonth	integer		No
expYear	integer		No
cvv	string		No
firstName	string		No
lastName	string		No
address1	string		No
address2	string		No
city	string		No
province	string		No
postalCode	string		No
countryCode	string		No
achName	string		No
achAccountType	ACHAccountType		No
achAccountNumber	string		No
achRoutingNumber	string		No
guestComments	string		No
guestAddress	Address		No

CheckoutResponse

Name	Type	Description	Required
body	string		No
error	string		No
redirect	string		No
confirmation	string		No
token	string		No
guestData	Address		No
callErrors	[ CallError ]		No

Date

Name	Type	Description	Required
year	integer		No
month	integer		No
day	integer		No

FailOn

Name	Type	Description	Required
FailOn	string

FieldType

Name	Type	Description	Required
FieldType	string

Gateway

Name	Type	Description	Required
Gateway	string

Header

Name	Type	Description	Required
name	string		No
value	string		No

InitiateRequest

Name	Type	Description	Required
gateway	Gateway		No
invoice	Invoice		No
callGroups	[ CallGroup ]		No
confirmationReplacement	Replacement		No
callback	string		No
cardTypes	[ string ]		No
engine	string		No
source	string		No
type	integer		No
id	string		No

InitiateResponse

Name	Type	Description	Required
token	string		No

InitiateSession

Name	Type	Description	Required
Authorization	string		No
apiKey	string		No
request	InitiateRequest		No

Invoice

Name	Type	Description	Required
paymentTypes	[ PaymentType ]		No
acceptedCards	[ AcceptedCards ]		No
defaultAddress	Address		No
branding	Branding		No
description	string		No
reservations	[ Reservation ]		No
payments	[ Payment ]		No
lineItems	[ LineItem ]		No
tax	float		No
subTotal	float		No
total	float		No
due	float		No
currencyCode	string		No
locale	string		No
termsConditions	string		No
collectComments	boolean		No
showGuestAddress	boolean		No

LineItem

Name	Type	Description	Required
description	string		No
amount	float		No

Payment

Name	Type	Description	Required
description	string		No
amount	float		No
due	boolean		No
dueDate	Date		No

PaymentType

Payment type of ANY is used for call groups that should be executed regardless of the payment type. Examples are signing virtual agreement, reconciling a reservation, etc.

Name	Type	Description	Required
PaymentType	string	Payment type of ANY is used for call groups that should be executed regardless of the payment type. Examples are signing virtual agreement, reconciling a reservation, etc.

Replacement

A Replacement defines a change to a call body. The source describes a previous call response or data collected from a form. Destination defines the element in the call body to be replaced.

Name	Type	Description	Required
source	string		No
sourceField	string		No
sourceKey	string	Optional key for a XML_ATTRIBUTE source.	No
sourceType	FieldType		No
destinationField	string		No
destinationKey	string		No
destinationType	FieldType		No
operation	ReplacementOperation		No

ReplacementOperation

Name	Type	Description	Required
ReplacementOperation	string

Reservation

Name	Type	Description	Required
checkin	Date		No
checkout	Date		No
guests	float		No
pets	float		No
title	string		No
image	string		No
beds	float		No
baths	float		No
rating	float		No
reviews	float		No
charges	[ LineItem ]		No
total	float		No

SessionRequest

Name	Type	Description	Required
token	string		No

Verb

Name	Type	Description	Required
Verb	string

protobufAny

Name	Type	Description	Required
type_url	string		No
value	byte		No

runtimeError

Name	Type	Description	Required
error	string		No
code	integer		No
message	string		No
details	[ protobufAny ]		No