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 .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.

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

<MembershipProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Alias>String</Alias>
  <CanBePurchased>false</CanBePurchased>
  <Cost>
    <MembershipProductCostDuration>
      <Cost>
        <DiscountType>NoDiscount</DiscountType>
        <FullPrice>0</FullPrice>
        <MonthlyPrice>0</MonthlyPrice>
        <Price>0</Price>
        <SiteCode>String</SiteCode>
      </Cost>
      <Duration>
        <DurationType>Day</DurationType>
        <Length>0</Length>
      </Duration>
      <ProductID>String</ProductID>
      <ProductIDAndroid>String</ProductIDAndroid>
      <Token>String</Token>
      <VerotelSiteCode>String</VerotelSiteCode>
    </MembershipProductCostDuration>
  </Cost>
  <MemberLevel>Guest</MemberLevel>
  <MemberLevelValue>0</MemberLevelValue>
  <Name>String</Name>
</MembershipProduct>