class GoCardlessPro::Resources::PayoutItem

When we collect a payment on your behalf, we add the money you've collected to your GoCardless balance, minus any fees paid. Periodically (usually every working day), we take any positive balance in your GoCardless account, and pay it out to your nominated bank account.

Other actions in your GoCardless account can also affect your balance. For example, if a customer charges back a payment, we'll deduct the payment's amount from your balance, but add any fees you paid for that payment back to your balance.

The Payout Items API allows you to view, on a per-payout basis, the credit and debit items that make up that payout's amount.

Attributes

amount[R]
taxes[R]
type[R]

Public Class Methods

new(object, response = nil) click to toggle source

Initialize a payout_item resource instance @param object [Hash] an object returned from the API

# File lib/gocardless_pro/resources/payout_item.rb, line 40
def initialize(object, response = nil)
  @object = object

  @amount = object['amount']
  @links = object['links']
  @taxes = object['taxes']
  @type = object['type']
  @response = response
end

Public Instance Methods

api_response() click to toggle source
# File lib/gocardless_pro/resources/payout_item.rb, line 50
def api_response
  ApiResponse.new(@response)
end
to_h() click to toggle source

Provides the payout_item resource as a hash of all its readable attributes

# File lib/gocardless_pro/resources/payout_item.rb, line 60
def to_h
  @object
end