RHP_API

<back to all web services

CreateAppleServerNotification

End point to receive Apple Server Notifications

The following routes are available for this service:
All Verbs/Apple/RealTimeNotice
CreateAppleServerNotificationRequest Parameters:
NameParameterData TypeRequiredDescription
auto_renew_adam_idformstringNo
auto_renew_product_idformstringNo
auto_renew_statusformstringNo
auto_renew_status_change_dateformstringNo
auto_renew_status_change_date_msformstringNo
auto_renew_status_change_date_pstformstringNo
environmentformstringNo
expiration_intentformintNo
notification_typeformstringNo
NotificationTypeEnumformAppleNotificationTypeNo
passwordformstringNo
unified_receiptformUnifiedReceiptNo
bidformstringNo
bvrsformstringNo
UnifiedReceipt Parameters:
NameParameterData TypeRequiredDescription
environmentformstringNo
latest_receiptformstringNo
latest_receipt_infoformInAppReceipt[]No
pending_renewal_infoformPendingRenewalInfo[]No
statusformintNo
InAppReceipt Parameters:
NameParameterData TypeRequiredDescription
cancellation_dateformstringNo
cancellation_date_msformstringNo
cancellation_date_pstformstringNo
cancellation_reasonformstringNo
expires_dateformstringNo
expires_date_msformstringNo
expires_date_pstformstringNo
is_in_intro_offer_periodformstringNo
is_trial_periodformstringNo
is_upgradedformstringNo
offer_code_ref_nameformstringNo
original_purchase_dateformstringNo
original_purchase_date_msformstringNo
original_purchase_date_pstformstringNo
original_transaction_idformstringNo
product_idformstringNo
promotional_offer_idformstringNo
purchase_dateformstringNo
purchase_date_msformstringNo
purchase_date_pstformstringNo
quantityformstringNo
subscription_group_identifierformstringNo
transaction_idformstringNo
web_order_line_item_idformstringNo
PendingRenewalInfo Parameters:
NameParameterData TypeRequiredDescription
auto_renew_product_idformstringNo
auto_renew_statusformstringNo
expiration_intentformstringNo
grace_period_expires_dateformstringNo
grace_period_expires_date_msformstringNo
grace_period_expires_date_pstformstringNo
is_in_billing_retry_periodformstringNo
offer_code_ref_nameformstringNo
original_transaction_idformstringNo
price_consent_statusformstringNo
product_idformstringNo

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.

POST /Apple/RealTimeNotice HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateAppleServerNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <NotificationTypeEnum xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">NotSet</NotificationTypeEnum>
  <auto_renew_adam_id xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</auto_renew_adam_id>
  <auto_renew_product_id xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</auto_renew_product_id>
  <auto_renew_status xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</auto_renew_status>
  <auto_renew_status_change_date xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</auto_renew_status_change_date>
  <auto_renew_status_change_date_ms xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</auto_renew_status_change_date_ms>
  <auto_renew_status_change_date_pst xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</auto_renew_status_change_date_pst>
  <bid xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</bid>
  <bvrs xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</bvrs>
  <environment xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</environment>
  <expiration_intent xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">0</expiration_intent>
  <notification_type xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</notification_type>
  <password xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">String</password>
  <unified_receipt xmlns="http://schemas.datacontract.org/2004/07/RHP.External.Apple.Model">
    <environment>String</environment>
    <latest_receipt>String</latest_receipt>
    <latest_receipt_info>
      <InAppReceipt>
        <cancellation_date>String</cancellation_date>
        <cancellation_date_ms>String</cancellation_date_ms>
        <cancellation_date_pst>String</cancellation_date_pst>
        <cancellation_reason>String</cancellation_reason>
        <expires_date>String</expires_date>
        <expires_date_ms>String</expires_date_ms>
        <expires_date_pst>String</expires_date_pst>
        <is_in_intro_offer_period>String</is_in_intro_offer_period>
        <is_trial_period>String</is_trial_period>
        <is_upgraded>String</is_upgraded>
        <offer_code_ref_name>String</offer_code_ref_name>
        <original_purchase_date>String</original_purchase_date>
        <original_purchase_date_ms>String</original_purchase_date_ms>
        <original_purchase_date_pst>String</original_purchase_date_pst>
        <original_transaction_id>String</original_transaction_id>
        <product_id>String</product_id>
        <promotional_offer_id>String</promotional_offer_id>
        <purchase_date>String</purchase_date>
        <purchase_date_ms>String</purchase_date_ms>
        <purchase_date_pst>String</purchase_date_pst>
        <quantity>String</quantity>
        <subscription_group_identifier>String</subscription_group_identifier>
        <transaction_id>String</transaction_id>
        <web_order_line_item_id>String</web_order_line_item_id>
      </InAppReceipt>
    </latest_receipt_info>
    <pending_renewal_info>
      <PendingRenewalInfo>
        <auto_renew_product_id>String</auto_renew_product_id>
        <auto_renew_status>String</auto_renew_status>
        <expiration_intent>String</expiration_intent>
        <grace_period_expires_date>String</grace_period_expires_date>
        <grace_period_expires_date_ms>String</grace_period_expires_date_ms>
        <grace_period_expires_date_pst>String</grace_period_expires_date_pst>
        <is_in_billing_retry_period>String</is_in_billing_retry_period>
        <offer_code_ref_name>String</offer_code_ref_name>
        <original_transaction_id>String</original_transaction_id>
        <price_consent_status>String</price_consent_status>
        <product_id>String</product_id>
      </PendingRenewalInfo>
    </pending_renewal_info>
    <status>0</status>
  </unified_receipt>
</CreateAppleServerNotification>