RHP_API

<back to all web services

GetDecodedPayment

Decode payment request

Requires Authentication
The following routes are available for this service:
GET/User/Purchase/DecodePurchase
GetDecodedPayment Parameters:
NameParameterData TypeRequiredDescription
CodequerystringNo
MembershipProduct Parameters:
NameParameterData TypeRequiredDescription
CostformList<MembershipProductCostDuration>No
NameformstringNo
AliasformstringNo
MemberLevelformMemberLevelTypeNo
MemberLevelValueformintNo
CanBePurchasedformboolNo
MembershipProductCostDuration Parameters:
NameParameterData TypeRequiredDescription
TokenformstringNo
DurationformMembershipProductDurationNo
CostformMembershipProductCostNo
VerotelSiteCodeformstringNo
ProductIDformstringNo
ProductIDAndroidformstringNo
MembershipProductDuration Parameters:
NameParameterData TypeRequiredDescription
DurationTypeformMembershipDurationTypeNo
LengthformintNo
MembershipProductCost Parameters:
NameParameterData TypeRequiredDescription
FullPriceformdecimalNo
PriceformdecimalNo
MonthlyPriceformdecimalNo
DiscountTypeformMembershipDiscountTypeNo
SiteCodeformstringNo

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.

GET /User/Purchase/DecodePurchase HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Cost: 
	[
		{
			Token: String,
			Duration: 
			{
				DurationType: Day,
				Length: 0
			},
			Cost: 
			{
				FullPrice: 0,
				Price: 0,
				MonthlyPrice: 0,
				DiscountType: NoDiscount,
				SiteCode: String
			},
			VerotelSiteCode: String,
			ProductID: String,
			ProductIDAndroid: String
		}
	],
	Name: String,
	Alias: String,
	MemberLevel: Guest,
	MemberLevelValue: 0,
	CanBePurchased: False
}