mangopay-v4 4.0.0

data/lib/mangopay/model/entity/pay_in/bank_wire_direct_pay_in.rb

@@ -0,0 +1,22 @@
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Bank Wire Direct Pay-In entity
+  # A Bank Wire Pay-In is a request to process a payment by bank wire
+  class BankWireDirectPayIn < PayIn
+    include MangoPay::Jsonifier
+
+    # [Money] The declared debited funds
+    attr_accessor :declared_debited_funds
+
+    # [Money] The declared fees
+    attr_accessor :declared_fees
+
+    # [String] Wire reference
+    attr_accessor :wire_reference
+
+    # [BankAccount] The bank account details
+    attr_accessor :bank_account
+  end
+end

data/lib/mangopay/model/entity/pay_in/card_direct_pay_in.rb

@@ -0,0 +1,33 @@
+require_relative 'pay_in'
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Card Direct Pay In entity
+  # The Card Direct Pay In object lets you pay with a registered card.
+  class CardDirectPayIn < PayIn
+    include MangoPay::Jsonifier
+
+    # [String] URL which users are automatically redirected to
+    # after 3D secure validation (if activated)
+    attr_accessor :secure_mode_return_url
+
+    # [CardType] ID of the card
+    attr_accessor :card_id
+
+    # [SecureMode] The Secure Mode Corresponds to '3D secure' for CB Visa and
+    # Mastercard. This field allows manual activation.
+    attr_accessor :secure_mode
+
+    # [String] Custom description to appear on the user's bank statement.
+    # (max 100 alphanumeric/spaces)
+    attr_accessor :statement_descriptor
+
+    # [true/false] Whether the Secure Mode was used
+    attr_accessor :secure_mode_needed
+
+    # [String] The URL where to redirect users to proceed to
+    # 3D secure validation
+    attr_accessor :secure_mode_redirect_url
+  end
+end

data/lib/mangopay/model/entity/pay_in/card_pre_authorized_pay_in.rb

@@ -0,0 +1,13 @@
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Allows payment through a card for which the action has
+  # been pre-authorized
+  class CardPreAuthorizedPayIn < PayIn
+    include MangoPay::Jsonifier
+
+    # [String] ID of the corresponding pre-authorization
+    attr_accessor :preauthorization_id
+  end
+end

data/lib/mangopay/model/entity/pay_in/card_web_pay_in.rb

@@ -0,0 +1,40 @@
+require_relative 'pay_in'
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Card Web Pay-In entity
+  # A Pay In by card and via web interface is a request
+  # to process a payment to a wallet for a dedicated user.
+  class CardWebPayIn < PayIn
+    include MangoPay::Jsonifier
+
+    # [String] URL to redirect to after payment
+    attr_accessor :return_url
+
+    # [CardType] The type of card
+    attr_accessor :card_type
+
+    # [SecureMode] The Secure Mode Corresponds to '3D secure' for CB Visa and
+    # Mastercard. This field allows manual activation.
+    attr_accessor :secure_mode
+
+    # [CultureCode] The language to use for the payment page
+    attr_accessor :culture
+
+    # [String] The URL to use for the payment page template
+    attr_accessor :template_url
+
+    # [TemplateUrlOptions] An URL to an SSL page to allow customization
+    # of the payment page
+    attr_accessor :template_url_options
+
+    # [String] Custom description to appear on the user's bank statement.
+    # (max 100 alphanumeric/spaces)
+    attr_accessor :statement_descriptor
+
+    # [String] The URL to redirect the user to for them to proceed
+    # with the payment
+    attr_accessor :redirect_url
+  end
+end

data/lib/mangopay/model/entity/pay_in/direct_debit_direct_pay_in.rb

@@ -0,0 +1,23 @@
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Direct-Debit Direct Pay-In entity
+  # A Pay-In by Direct Debit with a Mandate is a request to process a
+  # payment to a wallet for a dedicated user
+  class DirectDebitDirectPayIn < PayIn
+    include MangoPay::Jsonifier
+
+    # [String] ID of the mandate
+    attr_accessor :mandate_id
+
+    # [Integer] Date when the user will be charged (UNIX timestamp)
+    # Note: For Direct-Debit payments, it will take one more day
+    # before the payment becomes successful.
+    attr_accessor :charge_date
+
+    # [String] A custom description to appear on the user's bank statement.
+    # (max 100 alphanumeric/spaces, available only for SEPA payments)
+    attr_accessor :statement_descriptor
+  end
+end

data/lib/mangopay/model/entity/pay_in/direct_debit_web_pay_in.rb

@@ -0,0 +1,38 @@
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Direct-Debit Web Pay-In entity
+  # A Pay-In by Direct Debit and via Web is a request to process
+  # a payment to a wallet for a dedicated user
+  class DirectDebitWebPayIn < PayIn
+    include MangoPay::Jsonifier
+
+    # [String] URL to redirect to after payment
+    attr_accessor :return_url
+
+    # [DirectDebitType] Type of web direct debit
+    attr_accessor :direct_debit_type
+
+    # [CardType] The type of card
+    attr_accessor :card_type
+
+    # [SecureMode] The Secure Mode Corresponds to '3D secure' for CB Visa and
+    # Mastercard. This field allows manual activation.
+    attr_accessor :secure_mode
+
+    # [CultureCode] The language to use for the payment page
+    attr_accessor :culture
+
+    # [String] The URL to use for the payment page template
+    attr_accessor :template_url
+
+    # [TemplateUrlOptions] An URL to an SSL page to allow customization
+    # of the payment page
+    attr_accessor :template_url_options
+
+    # [String] URL which to redirect user to in order to proceed
+    # with the payment
+    attr_accessor :redirect_url
+  end
+end

data/lib/mangopay/model/entity/pay_in/pay_in.rb

@@ -0,0 +1,16 @@
+require_relative '../transaction'
+require_relative '../../../util/non_instantiable'
+
+module MangoModel
+
+  # Pay In entity
+  class PayIn < Transaction
+    extend NonInstantiable
+
+    # [PayInPaymentType] Its type
+    attr_accessor :payment_type
+
+    # [PayInExecutionType] Its execution type
+    attr_accessor :execution_type
+  end
+end

data/lib/mangopay/model/entity/pay_out.rb

@@ -0,0 +1,22 @@
+require_relative 'transaction'
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Pay-Out entity
+  # A Pay-Out bank-wire is a request to withdraw money from a wallet
+  # to a bank account.
+  class PayOut < Transaction
+    include MangoPay::Jsonifier
+
+    # [String] ID of the bank account
+    attr_accessor :bank_account_id
+
+    # [String] A custom reference to be present on the user's bank
+    # statement along with environment's Client name (max 12 chars)
+    attr_accessor :bank_wire_ref
+
+    # [PayOutPaymentType] Its type
+    attr_accessor :payment_type
+  end
+end

data/lib/mangopay/model/entity/pre_authorization.rb

@@ -0,0 +1,68 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Pre-Authorization entity
+  # The Pre-Authorization object ensures the solvency of a
+  # registered card for 7 days.
+  #
+  # The overall process is as follows:
+  # Register a card (CardRegistration)
+  # Create a PreAuthorization with the CardId. This allows you to charge an amount on a card
+  # Charge the card through the PreAuthorized PayIn object (Payins/preauthorized/direct)
+  #
+  # How does PreAuthorization work?
+  # Once the PreAuthorization object is created the Status is "CREATED" until 3D secure validation.
+  # If the authorization is successful the status is "SUCCEEDED" if it failed the status is "FAILED".
+  # Once Status = "SUCCEEDED" and PaymentStatus = "WAITING" you can charge the card.
+  # The Pay-In amount has to be less than or equal to the amount authorized.
+  class PreAuthorization < EntityBase
+    include MangoPay::Jsonifier
+
+    # [String] Its authoring user's ID
+    attr_accessor :author_id
+
+    # [Money] Information about the funds being debited
+    attr_accessor :debited_funds
+
+    # [PreAuthorizationStatus] Its status
+    attr_accessor :status
+
+    # [PaymentStatus] Its pre-authorized payment status
+    # Can be set to +CANCELED+ if needed
+    attr_accessor :payment_status
+
+    # [String] Its result code
+    attr_accessor :result_code
+
+    # [String] Explanation of its result
+    attr_accessor :result_message
+
+    # [PreAuthorizationExecutionType] How the pre-authorization was executed
+    attr_accessor :execution_type
+
+    # [SecureMode] The Secure Mode Corresponds to '3D secure' for CB Visa and
+    # Mastercard. This field allows manual activation.
+    attr_accessor :secure_mode
+
+    # [String] ID of the pre-authorized card
+    attr_accessor :card_id
+
+    # [true/false] True if the Secure Mode was used
+    attr_accessor :secure_mode_needed
+
+    # [String] URL which to redirect users to in order to proceed
+    # to 3D secure validation
+    attr_accessor :secure_mode_redirect_url
+
+    # [String] URL which users are automatically redirected to
+    # after 3D secure validation
+    attr_accessor :secure_mode_return_url
+
+    # [Integer] Date by when the payment should be processed (UNIX timestamp)
+    attr_accessor :expiration_date
+
+    # [String] ID of the associated Pay-in
+    attr_accessor :pay_in_id
+  end
+end

data/lib/mangopay/model/entity/refund.rb

@@ -0,0 +1,18 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Refund entity
+  class Refund < Transaction
+    include MangoPay::Jsonifier
+
+    # [String] The initial transaction's ID
+    attr_accessor :initial_transaction_id
+
+    # [TransactionType] The initial transaction's type
+    attr_accessor :initial_transaction_type
+
+    # [RefundReason] Info about the reason for refund
+    attr_accessor :refund_reason
+  end
+end

data/lib/mangopay/model/entity/report.rb

@@ -0,0 +1,51 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Report entity
+  # The Report object enables possibility to download huge lists of
+  # transactions or wallets to CSV form for accounting and analysis
+  # purposes.
+  class Report < EntityBase
+    include MangoPay::Jsonifier
+
+    # [Integer] Time when the report was executed (UNIX timestamp)
+    attr_accessor :report_date
+
+    # [String] URL where the report can be downloaded
+    attr_accessor :download_url
+
+    # [String] URL which MangoPay will ping once the report is ready
+    # to be downloaded (works in a similar way to +Hook+s)
+    attr_accessor :callback_url
+
+    # [DownloadFormat] The format of the downloadable report
+    attr_accessor :download_format
+
+    # [ReportType] The type of report
+    attr_accessor :report_type
+
+    # [ReportStatus] Its status
+    attr_accessor :status
+
+    # [String] The column to sort by and the direction, separated
+    # by a ':' character (i.e. CreationDate:DESC)
+    attr_accessor :sort
+
+    # [true/false] Whether the report should be limited to the first
+    # 10 rows, making its execution faster
+    attr_accessor :preview
+
+    # [ReportFilter] Object which allows filtering of report entries
+    attr_accessor :filters
+
+    # [Array] List of names of the columns to be included in the report
+    attr_accessor :columns
+
+    # [String] The result code
+    attr_accessor :result_code
+
+    # [String] Explanation of the result
+    attr_accessor :result_message
+  end
+end

data/lib/mangopay/model/entity/repudiation.rb

@@ -0,0 +1,18 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Repudiation entity
+  # A Repudiation is created when a user has requested a chargeback
+  # for a pay-in and the bank has withdrawn the funds from MangoPay
+  # automatically. A repudiation is always linked to a dispute.
+  class Repudiation < Transaction
+    include MangoPay::Jsonifier
+
+    # [String] ID of the initial transaction
+    attr_accessor :initial_transaction_id
+
+    # [TransactionType] Type of the initial transaction
+    attr_accessor :initial_transaction_type
+  end
+end

data/lib/mangopay/model/entity/settlement_transfer.rb

@@ -0,0 +1,17 @@
+require_relative 'transfer'
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Settlement Transfer entity
+  # A Settlement Transfer is a transfer that can be used to settle
+  # the credit from a repudiation following a lost dispute (to impact
+  # the balance of the original wallet and settle the credit in your
+  # client credit wallet).
+  class SettlementTransfer < Transfer
+    include MangoPay::Jsonifier
+
+    # [String] ID of the associated repudiation transaction
+    attr_accessor :repudiation_id
+  end
+end

data/lib/mangopay/model/entity/transaction.rb

@@ -0,0 +1,52 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Transaction entity
+  # A transaction represents an action to relocate money.
+  class Transaction < EntityBase
+    include MangoPay::Jsonifier
+
+    # [Money] Information about the funds that are being debited
+    attr_accessor :debited_funds
+
+    # [Money] Information about the funds that are being credited
+    # (+DebitedFunds+ - +Fees+ = +Credited_Funds+)
+    attr_accessor :credited_funds
+
+    # [Money] Information about the fees that were taken by the client
+    # for this transaction (and transferred to the client's platform's wallet)
+    attr_accessor :fees
+
+    # [String] ID of the wallet that was debited from
+    attr_accessor :debited_wallet_id
+
+    # [String] ID of the wallet where money will be credited
+    attr_accessor :credited_wallet_id
+
+    # [String] ID of the initiating user
+    attr_accessor :author_id
+
+    # [String] ID of the user who will be credited (defaults
+    # to the owner of the wallet)
+    attr_accessor :credited_user_id
+
+    # [TransactionType] Type of the transaction
+    attr_accessor :type
+
+    # [TransactionNature] Nature of the transaction
+    attr_accessor :nature
+
+    # [TransactionStatus] Status of the transaction
+    attr_accessor :status
+
+    # [Integer] Time of execution of the transaction (UNIX timestamp)
+    attr_accessor :execution_date
+
+    # [String] Its result code
+    attr_accessor :result_code
+
+    # [String] Verbal explanation of the result
+    attr_accessor :result_message
+  end
+end