Class: Stripe::Treasury::CreditReversalService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/treasury/credit_reversal_service.rb

Defined Under Namespace

Classes: CreateParams, ListParams, RetrieveParams

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#create(params = {}, opts = {}) ⇒ Object

Reverses a ReceivedCredit and creates a CreditReversal object.



75
76
77
78
79
80
81
82
83
 
# File 'lib/stripe/services/treasury/credit_reversal_service.rb', line 75

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/treasury/credit_reversals",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

Returns a list of CreditReversals.



86
87
88
89
90
91
92
93
94
 
# File 'lib/stripe/services/treasury/credit_reversal_service.rb', line 86

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/treasury/credit_reversals",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(credit_reversal, params = {}, opts = {}) ⇒ Object

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list



97
98
99
100
101
102
103
104
105
 
# File 'lib/stripe/services/treasury/credit_reversal_service.rb', line 97

def retrieve(credit_reversal, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/treasury/credit_reversals/%<credit_reversal>s", { credit_reversal: CGI.escape(credit_reversal) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end