module GMO::Payment::SiteAPIMethods
Attributes
host[R]
locale[R]
site_id[R]
site_pass[R]
Public Class Methods
new(options = {})
click to toggle source
# File lib/gmo/site_api.rb 19 def initialize(options = {}) 20 @site_id = options[:site_id] 21 @site_pass = options[:site_pass] 22 @host = options[:host] 23 @locale = options.fetch(:locale, GMO::Const::DEFAULT_LOCALE) 24 unless @site_id && @site_pass && @host 25 raise ArgumentError, "Initialize must receive a hash with :site_id, :site_pass and either :host! (received #{options.inspect})" 26 end 27 end
Public Instance Methods
delete_brandtoken(options = {})
click to toggle source
@params ###
MemberID SeqMode TokenSeq
@return ###
TokenSeq
example ###
gmo.delete_brandtoken({
member_id: '598066176120b2235300020b', seq_mode: 0, token_seq: 0
})
> {“TokenSeq”=>“0”}¶ ↑
# File lib/gmo/site_api.rb 145 def delete_brandtoken(options = {}) 146 name = "DeleteBrandtoken.idPass" 147 required = [:member_id, :seq_mode, :token_seq] 148 assert_required_options(required, options) 149 post_request name, options 150 end
delete_card(options = {})
click to toggle source
2.8.2.1.カード削除
指定した会員のカード情報を削除します。
# File lib/gmo/site_api.rb 90 def delete_card(options = {}) 91 name = "DeleteCard.idPass" 92 required = [:member_id, :card_seq] 93 assert_required_options(required, options) 94 post_request name, options 95 end
delete_member(options = {})
click to toggle source
2.5.2.1.会員削除
指定したサイトから会員情報を削除します。
# File lib/gmo/site_api.rb 59 def delete_member(options = {}) 60 name = "DeleteMember.idPass" 61 required = [:member_id] 62 assert_required_options(required, options) 63 post_request name, options 64 end
exec_tran(options = {})
click to toggle source
2.11.2.3. 決済実行
お客様が選択したカード登録連番のカード情報を取得します。カード情報が本人認証サービスに対応していない場合は、カード会社との通信を行い決済を実行します。その際の出力パラメータは「2.10.2.3決済実行」の出力パラメータと同じになります。/payment/ExecTran.idPass
# File lib/gmo/site_api.rb 156 def exec_tran(options = {}) 157 name = "ExecTran.idPass" 158 required = [:access_id, :access_pass, :order_id, :member_id, :card_seq] 159 assert_required_options(required, options) 160 post_request name, options 161 end
save_card(options = {})
click to toggle source
2.7.2.1.カード登録/更新
指定した会員にカード情報を登録します。尚、サイトに設定されたショップ ID を使用してカード会社と通信を行い有効性の確認を行います。
# File lib/gmo/site_api.rb 77 def save_card(options = {}) 78 name = "SaveCard.idPass" 79 if options[:token].nil? 80 required = [:member_id, :card_no, :expire] 81 else 82 required = [:member_id, :token] 83 end 84 assert_required_options(required, options) 85 post_request name, options 86 end
save_member(options = {})
click to toggle source
2.3.2.1.会員登録
指定されたサイトに会員を登録します。
@params ###
MemberID
@return ###
MemberID
example ###
gmo.save_member({
member_id: 'mem10001'
})
> {“MemberID”=>“mem10001”}¶ ↑
# File lib/gmo/site_api.rb 41 def save_member(options = {}) 42 name = "SaveMember.idPass" 43 required = [:member_id] 44 assert_required_options(required, options) 45 post_request name, options 46 end
search_brandtoken(options = {})
click to toggle source
@params ###
MemberID SeqMode TokenSeq
@return ###
TokenSeq DefaultFlag CardName CardNoToken Expire HolderName DeleteFlag
example ###
gmo.search_brandtoken({
member_id: '598066176120b2235300020b', seq_mode: 0
})
> {“TokenSeq”=>“0”, “DefaultFlag”=>“0”, “CardName”=>“”, “CardNoToken”=>“*************111”, “Expire”=>“2212”, “HolderName”=>“”, “DeleteFlag”=>“0”}¶ ↑
# File lib/gmo/site_api.rb 125 def search_brandtoken(options = {}) 126 name = "SearchBrandtoken.idPass" 127 required = [:member_id, :seq_mode] 128 assert_required_options(required, options) 129 post_request name, options 130 end
search_card(options = {})
click to toggle source
2.9.2.1.カード参照
指定した会員のカード情報を参照します。/payment/SearchCard.idPass
# File lib/gmo/site_api.rb 100 def search_card(options = {}) 101 name = "SearchCard.idPass" 102 required = [:member_id, :seq_mode] 103 assert_required_options(required, options) 104 post_request name, options 105 end
search_card_detail_by_member_id(options = {})
click to toggle source
2.19.2.1.カード属性照会(サイトID+会員ID(+カード登録連番モード・カード登録連番)を指定して呼び出す場合)
指定したクレジットカードの属性情報を取得します。/payment/SearchCardDetail.idPass
# File lib/gmo/site_api.rb 166 def search_card_detail_by_member_id(options = {}) 167 name = "SearchCardDetail.idPass" 168 required = [:member_id, :seq_mode] 169 assert_required_options(required, options) 170 post_request name, options 171 end
search_member(options = {})
click to toggle source
2.6.2.1.会員参照
指定したサイトの会員情報を参照します。
# File lib/gmo/site_api.rb 68 def search_member(options = {}) 69 name = "SearchMember.idPass" 70 required = [:member_id] 71 assert_required_options(required, options) 72 post_request name, options 73 end
update_member(options = {})
click to toggle source
2.4.2.1.会員更新
指定されたサイトに会員情報を更新します。
# File lib/gmo/site_api.rb 50 def update_member(options = {}) 51 name = "UpdateMember.idPass" 52 required = [:member_id] 53 assert_required_options(required, options) 54 post_request name, options 55 end
Private Instance Methods
api_call(name, args = {}, verb = "post", options = {})
click to toggle source
# File lib/gmo/site_api.rb 175 def api_call(name, args = {}, verb = "post", options = {}) 176 args.merge!({ "SiteID" => @site_id, "SitePass" => @site_pass }) 177 api(name, args, verb, options) do |response| 178 if response.is_a?(Hash) && !response["ErrInfo"].nil? 179 raise APIError.new(response, locale) 180 end 181 end 182 end