Class: MangoModel::Mandate

Inherits:
EntityBase show all
Includes:
MangoPay::Jsonifier
Defined in:
lib/mangopay/model/entity/mandate.rb

Overview

Mandate entity

Constant Summary

Constants included from MangoPay::Jsonifier

MangoPay::Jsonifier::LOG

Instance Attribute Summary collapse

Attributes inherited from EntityBase

#creation_date, #id, #tag

Method Summary

Methods included from MangoPay::Jsonifier

#dejsonify, #jsonify!

Methods included from NonInstantiable

#initialize

Instance Attribute Details

#bank_account_idObject

String

ID of the concerned bank account



10
11
12
# File 'lib/mangopay/model/entity/mandate.rb', line 10

def 
  @bank_account_id
end

#bank_referenceObject

String

Its banking reference



49
50
51
# File 'lib/mangopay/model/entity/mandate.rb', line 49

def bank_reference
  @bank_reference
end

#cultureObject

MandateCultureCode

ISO code of the language to use for the mandate

confirmation page



27
28
29
# File 'lib/mangopay/model/entity/mandate.rb', line 27

def culture
  @culture
end

#document_urlObject

String

URL where the mandate can be downloaded



23
24
25
# File 'lib/mangopay/model/entity/mandate.rb', line 23

def document_url
  @document_url
end

#execution_typeObject

MandateExecutionType

Execution type for its creation



43
44
45
# File 'lib/mangopay/model/entity/mandate.rb', line 43

def execution_type
  @execution_type
end

#mandate_typeObject

MandateType

Its type



46
47
48
# File 'lib/mangopay/model/entity/mandate.rb', line 46

def mandate_type
  @mandate_type
end

#redirect_urlObject

String

URL which to redirect users to for them to proceed

with the payment



20
21
22
# File 'lib/mangopay/model/entity/mandate.rb', line 20

def redirect_url
  @redirect_url
end

#result_codeObject

String

Its result code



37
38
39
# File 'lib/mangopay/model/entity/mandate.rb', line 37

def result_code
  @result_code
end

#result_messageObject

String

Explanation of its result



40
41
42
# File 'lib/mangopay/model/entity/mandate.rb', line 40

def result_message
  @result_message
end

#return_urlObject

String

URL to redirect to after payment (whether or not successful)



16
17
18
# File 'lib/mangopay/model/entity/mandate.rb', line 16

def return_url
  @return_url
end

#schemeObject

MandateScheme

Its type, will only be set once the mandate

has been submitted



31
32
33
# File 'lib/mangopay/model/entity/mandate.rb', line 31

def scheme
  @scheme
end

#statusObject

MandateStatus

Its status



34
35
36
# File 'lib/mangopay/model/entity/mandate.rb', line 34

def status
  @status
end

#user_idObject

String

Its owner’s ID



13
14
15
# File 'lib/mangopay/model/entity/mandate.rb', line 13

def user_id
  @user_id
end