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. Payout
items can only be retrieved for payouts created in the last 6 months. Requests for older payouts will return an HTTP status 410 Gone
.
Attributes
Public Class Methods
Source
# 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
Initialize a payout_item resource instance @param object [Hash] an object returned from the API
Public Instance Methods
Source
# File lib/gocardless_pro/resources/payout_item.rb, line 50 def api_response ApiResponse.new(@response) end
Source
# File lib/gocardless_pro/resources/payout_item.rb, line 55 def links @payout_item_links ||= Links.new(@links) end
Return the links that the resource has
Source
# File lib/gocardless_pro/resources/payout_item.rb, line 60 def to_h @object end
Provides the payout_item resource as a hash of all its readable attributes