Starlite API

<back to all web services

AuthenticatedUrl

The following routes are available for this service:
POST/authenticatedUrl
AuthenticatedUrl Parameters:
NameParameterData TypeRequiredDescription
CmcIdbodystringYesThe cmc Id
AssociationIdbodystringNoThe association Id
PropertyAccountNumberbodystringNoThe Account number of the property
FirstNamebodystringNoThe User's first name
LastNamebodystringNoThe User's last name
PhonebodystringNoThe User's phone number
EmailbodystringYesThe User's email
ConfirmationUrlbodystringNoThe vendor's confirmation url
PropertyNicknamebodystringNoThe nickname of the property
AmountbodydecimalNoThe amount of the payment
BankAccountNumberbodystringNoThe bank account number for the payment
RoutingNumberbodystringNoThe bank's routing number
PaymentFrequencybodystringNoThe frequency of the payment
StyleSheetbodystringNoThe stylesheet url
ServiceResponseBase Parameters:
NameParameterData TypeRequiredDescription
IsSuccessfulformboolNoIdentifies whether the request executed successfully, however does not indicated requested data was found
StatusCodeformintNoThe status code returned by the service
StatusMessageformstringNoThe status message returned by the service
ServiceDebugFieldsformDictionary<string, 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 /authenticatedUrl HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CmcId: String,
	AssociationId: String,
	PropertyAccountNumber: String,
	FirstName: String,
	LastName: String,
	Phone: String,
	Email: String,
	ConfirmationUrl: String,
	PropertyNickname: String,
	Amount: 0,
	BankAccountNumber: String,
	RoutingNumber: String,
	PaymentFrequency: String,
	StyleSheet: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsSuccessful: False,
	StatusCode: 0,
	StatusMessage: String,
	ServiceDebugFields: 
	{
		ApiServiceHost: WAB-WEBPW02,
		ApiServiceHostVersion: 1.0.0.0
	}
}