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 .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 /Apple/RealTimeNotice HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	auto_renew_adam_id: String,
	auto_renew_product_id: String,
	auto_renew_status: String,
	auto_renew_status_change_date: String,
	auto_renew_status_change_date_ms: String,
	auto_renew_status_change_date_pst: String,
	environment: String,
	expiration_intent: 0,
	notification_type: String,
	NotificationTypeEnum: NotSet,
	password: String,
	unified_receipt: 
	{
		environment: String,
		latest_receipt: String,
		latest_receipt_info: 
		[
			{
				cancellation_date: String,
				cancellation_date_ms: String,
				cancellation_date_pst: String,
				cancellation_reason: String,
				expires_date: String,
				expires_date_ms: String,
				expires_date_pst: String,
				is_in_intro_offer_period: String,
				is_trial_period: String,
				is_upgraded: String,
				offer_code_ref_name: String,
				original_purchase_date: String,
				original_purchase_date_ms: String,
				original_purchase_date_pst: String,
				original_transaction_id: String,
				product_id: String,
				promotional_offer_id: String,
				purchase_date: String,
				purchase_date_ms: String,
				purchase_date_pst: String,
				quantity: String,
				subscription_group_identifier: String,
				transaction_id: String,
				web_order_line_item_id: String
			}
		],
		pending_renewal_info: 
		[
			{
				auto_renew_product_id: String,
				auto_renew_status: String,
				expiration_intent: String,
				grace_period_expires_date: String,
				grace_period_expires_date_ms: String,
				grace_period_expires_date_pst: String,
				is_in_billing_retry_period: String,
				offer_code_ref_name: String,
				original_transaction_id: String,
				price_consent_status: String,
				product_id: String
			}
		],
		status: 0
	},
	bid: String,
	bvrs: String
}