Class: ModernTreasury::Resources::PaymentOrders::Reversals

Inherits:
Object
  • Object
show all
Defined in:
lib/modern_treasury/resources/payment_orders/reversals.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Reversals

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Reversals.

Parameters:



95
96
97
 
# File 'lib/modern_treasury/resources/payment_orders/reversals.rb', line 95

def initialize(client:)
  @client = client
end

Instance Method Details

#create(payment_order_id, reason: , ledger_transaction: nil, metadata: nil, request_options: {}) ⇒ ModernTreasury::Models::PaymentOrders::Reversal

Some parameter documentations has been truncated, see Models::PaymentOrders::ReversalCreateParams for more details.

Create a reversal for a payment order.

Parameters:

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/modern_treasury/resources/payment_orders/reversals.rb', line 27

def create(payment_order_id, params)
  parsed, options = ModernTreasury::PaymentOrders::ReversalCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/payment_orders/%1$s/reversals", payment_order_id],
    body: parsed,
    model: ModernTreasury::PaymentOrders::Reversal,
    options: options
  )
end

#list(payment_order_id, after_cursor: nil, per_page: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::PaymentOrders::Reversal>

Get a list of all reversals of a payment order.

Parameters:

  • payment_order_id (String) —

    The ID of the relevant Payment Order.

  • after_cursor (String, nil)
  • per_page (Integer)
  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/modern_treasury/resources/payment_orders/reversals.rb', line 80

def list(payment_order_id, params = {})
  parsed, options = ModernTreasury::PaymentOrders::ReversalListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["api/payment_orders/%1$s/reversals", payment_order_id],
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::PaymentOrders::Reversal,
    options: options
  )
end

#retrieve(reversal_id, payment_order_id: , request_options: {}) ⇒ ModernTreasury::Models::PaymentOrders::Reversal

Get details on a single reversal of a payment order.

Parameters:

  • reversal_id (String) —

    The ID of the reversal.

  • payment_order_id (String) —

    The id of the payment order being reversed.

  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/modern_treasury/resources/payment_orders/reversals.rb', line 51

def retrieve(reversal_id, params)
  parsed, options = ModernTreasury::PaymentOrders::ReversalRetrieveParams.dump_request(params)
  payment_order_id =
    parsed.delete(:payment_order_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["api/payment_orders/%1$s/reversals/%2$s", payment_order_id, reversal_id],
    model: ModernTreasury::PaymentOrders::Reversal,
    options: options
  )
end