module GMO::Payment::RemittanceAPIMethods
Attributes
Public Class Methods
# File lib/gmo/remittance_api.rb 17 def initialize(options = {}) 18 @shop_id = options[:shop_id] 19 @shop_pass = options[:shop_pass] 20 @host = options[:host] 21 @locale = options.fetch(:locale, GMO::Const::DEFAULT_LOCALE) 22 unless @shop_id && @shop_pass && @host 23 raise ArgumentError, "Initialize must receive a hash with :shop_id, :shop_pass and either :host! (received #{options.inspect})" 24 end 25 end
Public Instance Methods
Method Deposit_ID Bank_ID
@return ###
Deposit_ID Bank_ID Method
example ###
gmo.cancel_deposit({
deposit_id: 'dep00000', bank_id: 'bank00000',
}) {“Deposit_ID”=>“dep00000”, “Bank_ID”=>“bank00000”, “Method”=>“2”}
# File lib/gmo/remittance_api.rb 192 def cancel_deposit(options = {}) 193 name = "/api/DepositRegistration.idPass" 194 options[:method] = 2 195 required = %i(bank_id deposit_id) 196 assert_required_options(required, options) 197 post_request name, options 198 end
Method Deposit_ID
@return ###
Deposit_ID Method
example ###
gmo.cancel_mail_deposit({
deposit_id: 'dep00001',
}) {“Deposit_ID”=>“dep00001”, “Method”=>“2”}
# File lib/gmo/remittance_api.rb 287 def cancel_mail_deposit(options = {}) 288 name = "/api/MailDepositRegistration.idPass" 289 options[:method] = 2 290 required = %i(deposit_id) 291 assert_required_options(required, options) 292 post_request name, options 293 end
Method Bank_ID Bank_Code Branch_Code Account_Type Account_Name Account_Number Branch_Code_Jpbank Account_Number_Jpbank Free
@return ###
Bank_ID Method ErrCode ErrInfo
example ###
gmo.create_account({
bank_id: 'bank00000', bank_code: '0001', branch_code: '813', account_type: :normal, account_name: 'An Yutzy', account_number: '0012345', branch_code_jp: '00567', account_number_jp: '01234567', free: 'foobar' # Metadata
}) {“Bank_ID”=>“bank00000”, “Method”=>“1”}
# File lib/gmo/remittance_api.rb 57 def create_account(options = {}) 58 name = "/api/AccountRegistration.idPass" 59 options[:method] = 1 60 options[:account_type] = GMO::Const::ACCOUNT_TYPES_MAP[options[:account_type]] 61 required = %i(bank_id bank_code branch_code account_type account_name account_number) 62 assert_required_options(required, options) 63 post_request name, options 64 end
Method Deposit_ID Bank_ID Amount
@return ###
Deposit_ID Bank_ID Method Amount Bank_Fee
example ###
gmo.create_deposit({
deposit_id: 'dep00000', bank_id: 'bank00000', amount: '1000'
}) {“Deposit_ID”=>“dep00000”, “Bank_ID”=>“bank00000”, “Method”=>“1”, “Amount”=>“1000”, “Bank_Fee”=>“27”}
# File lib/gmo/remittance_api.rb 170 def create_deposit(options = {}) 171 name = "/api/DepositRegistration.idPass" 172 options[:method] = 1 173 required = %i(bank_id deposit_id amount) 174 assert_required_options(required, options) 175 post_request name, options 176 end
Method Deposit_ID Mail_Address Amount Mail_Deposit_Account_Name Expire Shop_Mail_Address
@return ###
Method Amount Deposit_ID Expire
example ###
gmo.create_mail_deposit({
deposit_id: 'dep00001', deposit_email: 'anyutzy@demo.com', amount: 1000, deposit_account_name: 'An Yutzy', expire: 5, deposit_shop_email: 'anyutzy@demo.com'
}) {“Deposit_ID”=>“dep00009”, “Method”=>“1”, “Amount”=>“1200”, “Expire”=>“20170503”}
# File lib/gmo/remittance_api.rb 268 def create_mail_deposit(options = {}) 269 name = "/api/MailDepositRegistration.idPass" 270 options[:method] = 1 271 required = %i(deposit_id deposit_email amount deposit_account_name expire deposit_shop_email) 272 assert_required_options(required, options) 273 post_request name, options 274 end
Method Bank_ID
@return ###
Bank_ID Method ErrCode ErrInfo
example ###
gmo.delete_account({
bank_id: 'bank00000',
}) {“Bank_ID”=>“bank00000”, “Method”=>“3”}
# File lib/gmo/remittance_api.rb 117 def delete_account(options = {}) 118 name = "/api/AccountRegistration.idPass" 119 options[:method] = 3 120 required = %i(bank_id) 121 assert_required_options(required, options) 122 post_request name, options 123 end
Bank_ID
@return ###
Bank_ID Delete_Flag Bank_Name Bank_Code Branch_Name Branch_Code Account_Type Account_Number Account_Name Free Branch_Code_Jpbank Account_Number_Jpbank
example ###
gmo.search_account({
bank_id: 'bank12345'
}) {“Bank_ID”=>“bank12345”, “Delete_Flag”=>“0”, “Bank_Name”=>“みずほ銀行”, “Bank_Code”=>“0001”, “Branch_Name”=>“札幌支店”, “Branch_Code”=>“813”, “Account_Type”=>“1”, “Account_Number”=>“0012345”, “Account_Name”=>“An Yutzy”, “Free”=>“”, “Branch_Code_Jpbank”=>“”, “Account_Number_Jpbank”=>“”}
# File lib/gmo/remittance_api.rb 145 def search_account(options = {}) 146 name = "/api/AccountSearch.idPass" 147 required = %i(bank_id) 148 assert_required_options(required, options) 149 post_request name, options 150 end
@return ###
Shop_ID Balance Balance_Forecast
example ###
gmo.search_balance {“Shop_ID”=>“rshop00000071”, “Balance”=>“9818965”, “Balance_Forecast”=>“9818965”}
# File lib/gmo/remittance_api.rb 240 def search_balance(options = {}) 241 name = "/api/BalanceSearch.idPass" 242 post_request name, options 243 end
Deposit_ID
@return ###
Deposit_ID Bank_ID Bank_Name Bank_Code Branch_Name Branch_Code Account_Type Account_Number Account_Name Free Amount Bank_Fee Result Branch_Code_Jpbank Account_Number_Jpbank Deposit_Date Result_Detail
example ###
gmo.search_deposit({
deposit_id: 'dep00000'
}) {“Deposit_ID”=>“dep00000”, “Bank_ID”=>“bank163144”, “Bank_Name”=>“みずほ銀行”, “Bank_Code”=>“0001”, “Branch_Name”=>“札幌支店”, “Branch_Code”=>“813”, “Account_Type”=>“1”, “Account_Number”=>“0012345”, “Account_Name”=>“An Yutzy”, “Free”=>“”, “Amount”=>“181035”, “Bank_Fee”=>“270”, “Result”=>“0”, “Branch_Code_Jpbank”=>“”, “Account_Number_Jpbank”=>“”, “Deposit_Date”=>“”, “Result_Detail”=>“”}
# File lib/gmo/remittance_api.rb 225 def search_deposit(options = {}) 226 name = "/api/DepositSearch.idPass" 227 required = %i(deposit_id) 228 assert_required_options(required, options) 229 post_request name, options 230 end
Deposit_ID
@return ###
Deposit_ID Mail_Address Shop_Mail_Address Account_Name Amount Expire Status
example ###
gmo.search_mail_deposit({
deposit_id: 'dep00001'
}) {“Deposit_ID”=>“dep0001516”, “Mail_Address”=>“anyutzy@demo.com”, “Shop_Mail_Address”=>“anyutzy@demo.com”, “Account_Name”=>“An Yutzy”, “Amount”=>“1000”, “Expire”=>“20170503”, “Status”=>“0”}
# File lib/gmo/remittance_api.rb 310 def search_mail_deposit(options = {}) 311 name = "/api/MailDepositSearch.idPass" 312 required = %i(deposit_id) 313 assert_required_options(required, options) 314 post_request name, options 315 end
Method Bank_ID Bank_Code Branch_Code Account_Type Account_Name Account_Number Branch_Code_Jpbank Account_Number_Jpbank Free
@return ###
Bank_ID Method ErrCode ErrInfo
example ###
gmo.update_account({
bank_id: 'bank00000', bank_code: '0001', branch_code: '813', account_type: :normal, account_name: 'An Yutzy', account_number: '0012345', branch_code_jp: '00567', account_number_jp: '01234567', free: 'foobar' # Metadata
}) {“Bank_ID”=>“bank00000”, “Method”=>“2”}
# File lib/gmo/remittance_api.rb 95 def update_account(options = {}) 96 name = "/api/AccountRegistration.idPass" 97 options[:method] = 2 98 options[:account_type] = GMO::Const::ACCOUNT_TYPES_MAP[options[:account_type]] 99 required = %i(bank_id bank_code branch_code account_type account_name account_number) 100 assert_required_options(required, options) 101 post_request name, options 102 end
Private Instance Methods
# File lib/gmo/remittance_api.rb 319 def api_call(name, args = {}, verb = "post", options = {}) 320 args.merge!({ "Shop_ID" => @shop_id, "Shop_Pass" => @shop_pass }) 321 api(name, args, verb, options) do |response| 322 if response.is_a?(Hash) && !response["ErrInfo"].nil? 323 raise APIError.new(response, locale) 324 end 325 end 326 end