Class: MethodRuby::Resources::Payments::Reversals

Inherits:
Object
  • Object
show all
Defined in:
lib/method_ruby/resources/payments/reversals.rb

Overview

Reversals for payments

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:



113
114
115
 
# File 'lib/method_ruby/resources/payments/reversals.rb', line 113

def initialize(client:)
  @client = client
end

Instance Method Details

#list(payment_id, method_version:, request_options: {}) ⇒ MethodRuby::Models::Payments::ReversalListResponse

Some parameter documentations has been truncated, see Models::Payments::ReversalListParams for more details.

Returns a list of all reversals associated with a specific payment.

Parameters:

Returns:

See Also:



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/method_ruby/resources/payments/reversals.rb', line 98

def list(payment_id, params)
  parsed, options = MethodRuby::Payments::ReversalListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["payments/%1$s/reversals", payment_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Payments::ReversalListResponse,
    security: {secret_key: true},
    options: options
  )
end

#retrieve(reversal_id, payment_id:, method_version:, request_options: {}) ⇒ MethodRuby::Models::Payments::ReversalRetrieveResponse

Some parameter documentations has been truncated, see Models::Payments::ReversalRetrieveParams for more details.

Retrieves a specific reversal for a payment by its unique identifier.

Parameters:

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/method_ruby/resources/payments/reversals.rb', line 26

def retrieve(reversal_id, params)
  parsed, options = MethodRuby::Payments::ReversalRetrieveParams.dump_request(params)
  payment_id =
    parsed.delete(:payment_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["payments/%1$s/reversals/%2$s", payment_id, reversal_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Payments::ReversalRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end

#update(reversal_id, payment_id:, method_version:, status: nil, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Payments::ReversalUpdateResponse

Some parameter documentations has been truncated, see Models::Payments::ReversalUpdateParams for more details.

Updates a payment reversal. Currently supports updating the reversal status.

Parameters:

  • reversal_id (String) —

    Path param: Unique identifier for the reversal.

  • payment_id (String) —

    Path param: Unique identifier for the payment.

  • method_version (Symbol, MethodRuby::Models::Payments::ReversalUpdateParams::MethodVersion) —

    Header param: API version to use for this request. This spec targets ‘2025-12-01

  • status (String) —

    Body param: Updated status for the reversal.

  • idempotency_key (String) —

    Header param: Idempotency key for safely retrying a write request. Reuse the sam

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

Returns:

See Also:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/method_ruby/resources/payments/reversals.rb', line 64

def update(reversal_id, params)
  parsed, options = MethodRuby::Payments::ReversalUpdateParams.dump_request(params)
  payment_id =
    parsed.delete(:payment_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
  @client.request(
    method: :put,
    path: ["payments/%1$s/reversals/%2$s", payment_id, reversal_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: MethodRuby::Models::Payments::ReversalUpdateResponse,
    security: {secret_key: true},
    options: options
  )
end