API:store > set_subscription_rp｜INTER-STREAMサポート

ストア

store > set_subscription_rp

定期購読の定期支払いプロファイルを設定します。
この関数を使用する前に、"store > get_subscription_pre_rp_info" を使用して定期支払い情報を取得しておく必要があります。その後、定期支払いプロファイルを作成してこの機能を使用します。
・PayPalを使用している場合：PayPalで定期支払いプロファイルを作成し、ここでIDを入力する必要があります。
PayPalもストア機能拡張で正しく構成されている必要があります。
・他の支払いゲートウェイを使用している場合：最初に外部支払い処理プログラムを実装（使用可能とする様にストア拡張を構成）し、次に定期支払いの「プロファイルID」をストア拡張が通信に使用する値にする必要があります。外部支払い処理プログラムのスクリプトを使用して、プロファイルID経由でINTER-STREAMに支払いのステータスを「通知」できるようにする必要があります。従って、INTER-STREAMから要求された際に、スクリプトはペイメントゲートウェイと通信し、現在のプロファイルのペイメント情報を取得できる必要があります。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数	値	説明
go	store	APIセクション
do	set_subscription_rp	APIアクション
iq	User ID	ユーザーID

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=store&do=set_subscription_rp&iq={user_id}&{required information}

POST変数

以下のPOST変数は必須です。

変数	値	説明
subscriptionID	(string) Subscription ID	サブスクリプションID "get_subscription_pre_rp_info"関数によって報告されたものと同じである必要があります。
profileID	(string) RP Profile ID	定期支払いのプロファイルID
paymentMethodID	(int) Payment Method ID	使用された支払い方法のID 利用可能な値：2(PayPal), 3(外部支払い処理プログラム)
date_first_payment	(int) Unix Timestamp	最初の定期（自動）支払い日 "get_subscription_pre_rp_info"関数によって報告されたものと同じである必要があります。
rp_status	(string) Status	定期支払いプロファイルのステータス（"Active"にする必要があります）。その他の利用可能な値："Pending", "Cancelled", "Suspended", "Expired"

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok

{
    "ok":"Recurring payment profile was set"
}

リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス

{
    "error"      : "REQUEST_ERROR",
    "error_long" : "Missing signature"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Invalid User ID
ユーザーIDが指定されていないか無効です。

・REQUEST_ERROR | Invalid Subscription ID
サブスクリプションIDが指定されていないか無効です。

・REQUEST_ERROR | Invalid Profile ID
プロファイルIDが指定されていないか、空の文字列です。

・REQUEST_ERROR | Invalid Payment Method ID
支払い方法IDが指定されていないか無効です。

・REQUEST_ERROR | Invalid first payment date
最初の支払い日が指定されていないか無効です。

・REQUEST_ERROR | Invalid Profile Status
プロファイルのステータスが指定されていないか無効です。

・ERROR_PROFILE_STATUS | Profile status is not active
プロファイルのステータスがアクティブではありません。

・ERROR_SUBSCRIPTION_NOT_FOUND | Could not find the subscription
サブスクリプションが見つかりません。

・ERROR_SUBSCRIPTION_NOT_RENEWABLE | This subscription is not renewable. It must be reactivated first
このサブスクリプションは更新できません。

・ERROR_SUBSCRIPTION_INACTIVE | This subscription is not active
サブスクリプションがアクティブではありません。

・ERROR_ACTIVE_RP_PROFILE | The subscription already has an active recurring payments profile
定期購入に関連付けられている定期支払いプロファイルが既に存在します。

・ERROR_NO_PRODUCT | The associated product does not exist
関連商品が利用できなくなった可能性があります。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "store",
					"do"        => "set_subscription_rp",
					"iq"        => "2"
					);

// POST変数
$POST_VARS = array( 
					"subscriptionID"     => 26,
					"profileID"          => "MyUniqueExtAPIProfileID",
					"paymentMethodID"    => 3,
                    "date_first_payment" => 1508916090,
                    "rp_status"          => "Active"
					);