class GoCardlessPro::Resources::OutboundPayment
Outbound Payments represent payments sent from [creditors](core-endpoints-creditors).
GoCardless will notify you via a [webhook](appendix-webhooks) when the status of the outbound payment [changes](event-actions-outbound-payment).
<p class=“restricted-notice”><strong>Restricted</strong>: Outbound Payments are currently in Early Access and available only to a limited list of organisations. If you are interested in using this feature, please stay tuned for our public launch announcement. We are actively testing and refining our API to ensure it meets your needs and provides the best experience.</p>
Attributes
Public Class Methods
Source
# File lib/gocardless_pro/resources/outbound_payment.rb, line 31 def initialize(object, response = nil) @object = object @amount = object['amount'] @created_at = object['created_at'] @currency = object['currency'] @description = object['description'] @execution_date = object['execution_date'] @id = object['id'] @is_withdrawal = object['is_withdrawal'] @links = object['links'] @metadata = object['metadata'] @reference = object['reference'] @scheme = object['scheme'] @status = object['status'] @verifications = object['verifications'] @response = response end
Initialize a outbound_payment resource instance @param object [Hash] an object returned from the API
Public Instance Methods
Source
# File lib/gocardless_pro/resources/outbound_payment.rb, line 50 def api_response ApiResponse.new(@response) end
Source
# File lib/gocardless_pro/resources/outbound_payment.rb, line 55 def links @outbound_payment_links ||= Links.new(@links) end
Return the links that the resource has
Source
# File lib/gocardless_pro/resources/outbound_payment.rb, line 60 def to_h @object end
Provides the outbound_payment resource as a hash of all its readable attributes