paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/purchase_unit_request.rb

@@ -0,0 +1,193 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The purchase unit request. Includes required information for the payment
+  # contract.
+  class PurchaseUnitRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The API caller-provided external ID for the purchase unit. Required for
+    # multiple purchase units when you must update the order through `PATCH`. If
+    # you omit this value and the order contains only one purchase unit, PayPal
+    # sets this value to `default`.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # The total order amount with an optional breakdown that provides details,
+    # such as the total item amount, total tax amount, shipping, handling,
+    # insurance, and discounts, if any.<br/>If you specify `amount.breakdown`,
+    # the amount equals `item_total` plus `tax_total` plus `shipping` plus
+    # `handling` plus `insurance` minus `shipping_discount` minus
+    # discount.<br/>The amount must be a positive number. For listed of
+    # supported currencies and decimal precision, see the PayPal REST APIs <a
+    # href="/docs/integration/direct/rest/currency-codes/">Currency Codes</a>.
+    # @return [AmountWithBreakdown]
+    attr_accessor :amount
+
+    # The merchant who receives the funds and fulfills the order. The merchant
+    # is also known as the payee.
+    # @return [Payee]
+    attr_accessor :payee
+
+    # Any additional payment instructions to be consider during payment
+    # processing. This processing instruction is applicable for Capturing an
+    # order or Authorizing an Order.
+    # @return [PaymentInstruction]
+    attr_accessor :payment_instruction
+
+    # The purchase description. The maximum length of the character is dependent
+    # on the type of characters used. The character length is specified assuming
+    # a US ASCII character. Depending on type of character; (e.g. accented
+    # character, Japanese characters) the number of characters that that can be
+    # specified as input might not equal the permissible max length.
+    # @return [String]
+    attr_accessor :description
+
+    # The API caller-provided external ID. Used to reconcile client transactions
+    # with PayPal transactions. Appears in transaction and settlement reports
+    # but is not visible to the payer.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # The API caller-provided external invoice number for this order. Appears in
+    # both the payer's transaction history and the emails that the payer
+    # receives.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The soft descriptor is the dynamic text used to construct the statement
+    # descriptor that appears on a payer's card statement.<br><br>If an Order is
+    # paid using the "PayPal Wallet", the statement descriptor will appear in
+    # following format on the payer's card statement:
+    # <code><var>PAYPAL_prefix</var>+(space)+<var>merchant_descriptor</var>+(spa
+    # ce)+ <var>soft_descriptor</var></code><blockquote><strong>Note:</strong>
+    # The merchant descriptor is the descriptor of the merchant’s payment
+    # receiving preferences which can be seen by logging into the merchant
+    # account
+    # https://www.sandbox.paypal.com/businessprofile/settings/info/edit</blockqu
+    # ote>The <code>PAYPAL</code> prefix uses 8 characters. Only the first 22
+    # characters will be displayed in the statement. <br>For example,
+    # if:<ul><li>The PayPal prefix toggle is <code>PAYPAL *</code>.</li><li>The
+    # merchant descriptor in the profile is <code>Janes Gift</code>.</li><li>The
+    # soft descriptor is <code>800-123-1234</code>.</li></ul>Then, the statement
+    # descriptor on the card is <code>PAYPAL * Janes Gift 80</code>.
+    # @return [String]
+    attr_accessor :soft_descriptor
+
+    # An array of items that the customer purchases from the merchant.
+    # @return [Array[Item]]
+    attr_accessor :items
+
+    # The shipping details.
+    # @return [ShippingDetails]
+    attr_accessor :shipping
+
+    # Supplementary data about a payment. This object passes information that
+    # can be used to improve risk assessments and processing costs, for example,
+    # by providing Level 2 and Level 3 payment data.
+    # @return [SupplementaryData]
+    attr_accessor :supplementary_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_id'] = 'reference_id'
+      @_hash['amount'] = 'amount'
+      @_hash['payee'] = 'payee'
+      @_hash['payment_instruction'] = 'payment_instruction'
+      @_hash['description'] = 'description'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['soft_descriptor'] = 'soft_descriptor'
+      @_hash['items'] = 'items'
+      @_hash['shipping'] = 'shipping'
+      @_hash['supplementary_data'] = 'supplementary_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reference_id
+        payee
+        payment_instruction
+        description
+        custom_id
+        invoice_id
+        soft_descriptor
+        items
+        shipping
+        supplementary_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, reference_id: SKIP, payee: SKIP,
+                   payment_instruction: SKIP, description: SKIP,
+                   custom_id: SKIP, invoice_id: SKIP, soft_descriptor: SKIP,
+                   items: SKIP, shipping: SKIP, supplementary_data: SKIP)
+      @reference_id = reference_id unless reference_id == SKIP
+      @amount = amount
+      @payee = payee unless payee == SKIP
+      @payment_instruction = payment_instruction unless payment_instruction == SKIP
+      @description = description unless description == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @soft_descriptor = soft_descriptor unless soft_descriptor == SKIP
+      @items = items unless items == SKIP
+      @shipping = shipping unless shipping == SKIP
+      @supplementary_data = supplementary_data unless supplementary_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = AmountWithBreakdown.from_hash(hash['amount']) if hash['amount']
+      reference_id = hash.key?('reference_id') ? hash['reference_id'] : SKIP
+      payee = Payee.from_hash(hash['payee']) if hash['payee']
+      payment_instruction = PaymentInstruction.from_hash(hash['payment_instruction']) if
+        hash['payment_instruction']
+      description = hash.key?('description') ? hash['description'] : SKIP
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      soft_descriptor =
+        hash.key?('soft_descriptor') ? hash['soft_descriptor'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Item.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      shipping = ShippingDetails.from_hash(hash['shipping']) if hash['shipping']
+      supplementary_data = SupplementaryData.from_hash(hash['supplementary_data']) if
+        hash['supplementary_data']
+
+      # Create object from extracted values.
+      PurchaseUnitRequest.new(amount: amount,
+                              reference_id: reference_id,
+                              payee: payee,
+                              payment_instruction: payment_instruction,
+                              description: description,
+                              custom_id: custom_id,
+                              invoice_id: invoice_id,
+                              soft_descriptor: soft_descriptor,
+                              items: items,
+                              shipping: shipping,
+                              supplementary_data: supplementary_data)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/reauthorize_request.rb

@@ -0,0 +1,62 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Reauthorizes an authorized PayPal account payment, by ID. To ensure that
+  # funds are still available, reauthorize a payment after its initial three-day
+  # honor period expires. You can reauthorize a payment only once from days four
+  # to 29.<br/><br/>If 30 days have transpired since the date of the original
+  # authorization, you must create an authorized payment instead of
+  # reauthorizing the original authorized payment.<br/><br/>A reauthorized
+  # payment itself has a new honor period of three days.<br/><br/>You can
+  # reauthorize an authorized payment once. The allowed amount depends on
+  # context and geography, for example in US it is up to 115% of the original
+  # authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports
+  # only the `amount` request parameter.<blockquote><strong>Note:</strong> This
+  # request is currently not supported for Partner use cases.</blockquote>
+  class ReauthorizeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP)
+      @amount = amount unless amount == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      ReauthorizeRequest.new(amount: amount)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund.rb

@@ -0,0 +1,195 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The refund information.
+  class Refund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the refund.
+    # @return [RefundStatus]
+    attr_accessor :status
+
+    # The details of the refund status.
+    # @return [RefundStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the refund.
+    # @return [String]
+    attr_accessor :id
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # The API caller-provided external invoice number for this order. Appears in
+    # both the payer's transaction history and the emails that the payer
+    # receives.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The API caller-provided external ID. Used to reconcile API
+    # caller-initiated transactions with PayPal transactions. Appears in
+    # transaction and settlement reports.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # Reference ID issued for the card transaction. This ID can be used to track
+    # the transaction across processors, card brands and issuing banks.
+    # @return [String]
+    attr_accessor :acquirer_reference_number
+
+    # The reason for the refund. Appears in both the payer's transaction history
+    # and the emails that the payer receives.
+    # @return [String]
+    attr_accessor :note_to_payer
+
+    # The breakdown of the refund.
+    # @return [SellerPayableBreakdown]
+    attr_accessor :seller_payable_breakdown
+
+    # The details for the merchant who receives the funds and fulfills the
+    # order. The merchant is also known as the payee.
+    # @return [PayeeBase]
+    attr_accessor :payer
+
+    # An array of related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The date and time, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
+    # required while fractional seconds are
+    # optional.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :create_time
+
+    # The date and time, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
+    # required while fractional seconds are
+    # optional.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :update_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash['id'] = 'id'
+      @_hash['amount'] = 'amount'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['acquirer_reference_number'] = 'acquirer_reference_number'
+      @_hash['note_to_payer'] = 'note_to_payer'
+      @_hash['seller_payable_breakdown'] = 'seller_payable_breakdown'
+      @_hash['payer'] = 'payer'
+      @_hash['links'] = 'links'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+        id
+        amount
+        invoice_id
+        custom_id
+        acquirer_reference_number
+        note_to_payer
+        seller_payable_breakdown
+        payer
+        links
+        create_time
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP, id: SKIP, amount: SKIP,
+                   invoice_id: SKIP, custom_id: SKIP,
+                   acquirer_reference_number: SKIP, note_to_payer: SKIP,
+                   seller_payable_breakdown: SKIP, payer: SKIP, links: SKIP,
+                   create_time: SKIP, update_time: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == SKIP
+      @id = id unless id == SKIP
+      @amount = amount unless amount == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      unless acquirer_reference_number == SKIP
+        @acquirer_reference_number =
+          acquirer_reference_number
+      end
+      @note_to_payer = note_to_payer unless note_to_payer == SKIP
+      @seller_payable_breakdown = seller_payable_breakdown unless seller_payable_breakdown == SKIP
+      @payer = payer unless payer == SKIP
+      @links = links unless links == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = RefundStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      acquirer_reference_number =
+        hash.key?('acquirer_reference_number') ? hash['acquirer_reference_number'] : SKIP
+      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
+      if hash['seller_payable_breakdown']
+        seller_payable_breakdown = SellerPayableBreakdown.from_hash(hash['seller_payable_breakdown'])
+      end
+      payer = PayeeBase.from_hash(hash['payer']) if hash['payer']
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+
+      # Create object from extracted values.
+      Refund.new(status: status,
+                 status_details: status_details,
+                 id: id,
+                 amount: amount,
+                 invoice_id: invoice_id,
+                 custom_id: custom_id,
+                 acquirer_reference_number: acquirer_reference_number,
+                 note_to_payer: note_to_payer,
+                 seller_payable_breakdown: seller_payable_breakdown,
+                 payer: payer,
+                 links: links,
+                 create_time: create_time,
+                 update_time: update_time)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_incomplete_reason.rb

@@ -0,0 +1,20 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The reason why the refund has the `PENDING` or `FAILED` status.
+  class RefundIncompleteReason
+    REFUND_INCOMPLETE_REASON = [
+      # TODO: Write general description for ECHECK
+      ECHECK = 'ECHECK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_payment_instruction.rb

@@ -0,0 +1,68 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Any additional payments instructions during refund payment processing. This
+  # object is only applicable to merchants that have been enabled for PayPal
+  # Commerce Platform for Marketplaces and Platforms capability. Please speak to
+  # your account manager if you want to use this capability.
+  class RefundPaymentInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the amount that the API caller will contribute to the refund
+    # being processed. The amount needs to be lower than platform_fees amount
+    # originally captured or the amount that is remaining if multiple refunds
+    # have been processed. This field is only applicable to merchants that have
+    # been enabled for PayPal Commerce Platform for Marketplaces and Platforms
+    # capability. Please speak to your account manager if you want to use this
+    # capability.
+    # @return [Array[RefundPlatformFee]]
+    attr_accessor :platform_fees
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        platform_fees
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(platform_fees: SKIP)
+      @platform_fees = platform_fees unless platform_fees == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      platform_fees = nil
+      unless hash['platform_fees'].nil?
+        platform_fees = []
+        hash['platform_fees'].each do |structure|
+          platform_fees << (RefundPlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+
+      # Create object from extracted values.
+      RefundPaymentInstruction.new(platform_fees: platform_fees)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_platform_fee.rb

@@ -0,0 +1,52 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The platform or partner fee, commission, or brokerage fee that is associated
+  # with the transaction. Not a separate or isolated transaction leg from the
+  # external perspective. The platform fee is limited in scope and is always
+  # associated with the original payment for the purchase unit.
+  class RefundPlatformFee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:)
+      @amount = amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      RefundPlatformFee.new(amount: amount)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_request.rb

@@ -0,0 +1,100 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Refunds a captured payment, by ID. For a full refund, include an empty
+  # request body. For a partial refund, include an <code>amount</code> object in
+  # the request body.
+  class RefundRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # The API caller-provided external ID. Used to reconcile API
+    # caller-initiated transactions with PayPal transactions. Appears in
+    # transaction and settlement reports. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # The API caller-provided external invoice ID for this order. The pattern is
+    # defined by an external party and supports Unicode.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The reason for the refund. Appears in both the payer's transaction history
+    # and the emails that the payer receives. The pattern is defined by an
+    # external party and supports Unicode.
+    # @return [String]
+    attr_accessor :note_to_payer
+
+    # Any additional payments instructions during refund payment processing.
+    # This object is only applicable to merchants that have been enabled for
+    # PayPal Commerce Platform for Marketplaces and Platforms capability. Please
+    # speak to your account manager if you want to use this capability.
+    # @return [RefundPaymentInstruction]
+    attr_accessor :payment_instruction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['note_to_payer'] = 'note_to_payer'
+      @_hash['payment_instruction'] = 'payment_instruction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        custom_id
+        invoice_id
+        note_to_payer
+        payment_instruction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, custom_id: SKIP, invoice_id: SKIP,
+                   note_to_payer: SKIP, payment_instruction: SKIP)
+      @amount = amount unless amount == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @note_to_payer = note_to_payer unless note_to_payer == SKIP
+      @payment_instruction = payment_instruction unless payment_instruction == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
+      payment_instruction = RefundPaymentInstruction.from_hash(hash['payment_instruction']) if
+        hash['payment_instruction']
+
+      # Create object from extracted values.
+      RefundRequest.new(amount: amount,
+                        custom_id: custom_id,
+                        invoice_id: invoice_id,
+                        note_to_payer: note_to_payer,
+                        payment_instruction: payment_instruction)
+    end
+  end
+end