13-03-26.継続決済IF情報編集API

投稿日：2018年7月5日

API名	継続決済IF情報編集API
ID	el_monthlypayIFInfo_upd_api

2.詳細解説

特定の受講者に対して月定額決済（継続決済IF）への接続を行います。当該API実行前に、事前にクレジット決済代行会社に対し、「受講者ID」を会員番号にしてクレジット決済登録を行っておく必要があります。当該APIは、クレジット決済代行会社からの決済完了後に遷移する画面において

$cstream->call_el_monthlypayIFInfo_upd_api($input_array);

3.I/O情報

INPUT

No	項目名	項目ID	項目説明	必須
1	会社ID	kaisha_id	会社を表すID	〇
2	アクセスキー	access_key	APIを認証するためのアクセスキー	〇
3	受講者ID	userid		〇
4	継続決済IF番号	monthlypay_if_no	更新する継続決済IFの番号（IF〇〇〇〇）	〇
5	更新種類	upd_type	0:登録登録　9:退会	〇

OUTPUT

No		項目名	項目ID	項目説明
1		実行フラグ	exec_flg	1:正常　9:エラー
2		エラータイプ	error_type	実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3		エラーメッセージ	error_msg	エラーごとに発生するメッセージ
4		エラー情報	error_info	エラーメッセージを表示（登録に失敗したケース）
	4-1	受講者ID	userid
	4-2	継続決済IF番号	monthlypay_if_no
	4-3	更新種類	upd_type

エラー

エラータイプ	エラー概要	発生させるメッセージ	発生させるException
0	アクセスキー不適合エラー	アクセスキーが適合しません。	AccessKeyException
1	ホスト許可エラー	対象のホストからのAPI実行を許可していません。	HostRestrictException
2	引数エラー	呼出パラメータが不足しているため実行できません。	CallParameterException
3	登録エラー	登録が失敗しました	AddDataException
9	システムメンテナンスエラー	現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。	SystemMaintenanceException

4.実装例

$apiParams = array();
$apiParams['monthlypay_if_no'] = 'IF0001';
$apiParams['userid'] = 'U007859';
$apiParams['upd_type'] = '0';

try{
	$output = $cstream->call_el_monthlypayIFInfo_upd_api($apiParams);

}catch (Exception $e) {
	$arrError[0] = $e->getMessage();
	if($output['exec_flg'] == 1){
		//成功！
	}else{
		echo $output['error_msg'];
	}
}

$apiParams = array();

$apiParams['monthlypay_if_no'] = 'IF0001';

$apiParams['userid'] = 'U007859';

$apiParams['upd_type'] = '0';

try{

$output = $cstream->call_el_monthlypayIFInfo_upd_api($apiParams);

}catch (Exception $e) {

$arrError[0] = $e->getMessage();

if($output['exec_flg'] == 1){

//成功！

}else{

echo $output['error_msg'];

}