RHP_API

GetActiveUserCredits

Get current User Credits

The following routes are available for this service:
GET	/User/Purchase/Credits

**UserCreditRecord** Parameters:
Name	Parameter	Data Type	Required	Description
CurrentConversationCredits	form	int	No	Available Conversation Credits
Purchases	form	List<UserCreditPurchase>	No	Purhcase History for Conversation Credits & Diamonds
CurrentStoreCredits	form	int	No
Diamonds	form	int	No	Diamonds available to spend
DiamondsBalance	form	int	No	Total available Diamonds

**UserCreditPurchase** Parameters:
Name	Parameter	Data Type	Required
Currency	form	Currency	No
Amount	form	decimal	No
ExpiryDate	form	DateTime	No
PurchaseDate	form	DateTime	No
PaymentProvider	form	PaymentProvider	No
PaymentProviderTitle	form	string	No
ProductName	form	string	No
CreditAmount	form	int	No
ProductGroup	form	PurchaseOrderType	No

**Currency** Parameters:
Name	Parameter	Data Type	Required
CurrencyID	form	int	No
Name	form	string	No
Symbol	form	string	No
Code	form	string	No
DateCreated	form	DateTime	No

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/Credits HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserCreditRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <CurrentConversationCredits>0</CurrentConversationCredits>
  <CurrentStoreCredits>0</CurrentStoreCredits>
  <Diamonds>0</Diamonds>
  <DiamondsBalance>0</DiamondsBalance>
  <Purchases>
    <UserCreditPurchase>
      <Amount>0</Amount>
      <CreditAmount>0</CreditAmount>
      <Currency xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.Model">
        <d4p1:Code>String</d4p1:Code>
        <d4p1:CurrencyID>0</d4p1:CurrencyID>
        <d4p1:DateCreated>0001-01-01T00:00:00</d4p1:DateCreated>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:Symbol>String</d4p1:Symbol>
      </Currency>
      <ExpiryDate>0001-01-01T00:00:00</ExpiryDate>
      <PaymentProvider>Verotel</PaymentProvider>
      <PaymentProviderTitle>String</PaymentProviderTitle>
      <ProductGroup>ConversationCredits</ProductGroup>
      <ProductName>String</ProductName>
      <PurchaseDate>0001-01-01T00:00:00</PurchaseDate>
    </UserCreditPurchase>
  </Purchases>
</UserCreditRecord>