Class: Billingrails::Resources::Payments

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

Overview

Payments resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Payments

Returns a new instance of Payments.

Parameters:

  • client (Client) —

    The API client



10
11
12
 
# File 'lib/billingrails/resources/payments.rb', line 10

def initialize(client)
  @client = client
end

Instance Method Details

#create(data) ⇒ Hash

Create a payment

Create an online or offline payment for an invoice, payment request, or credit grant.

Parameters:

  • data (Hash) —

    Request body

Returns:

  • (Hash) —

    Response data



31
32
33
34
 
# File 'lib/billingrails/resources/payments.rb', line 31

def create(data)
  path = "/payments"
  @client.request(:post, path, body: data)
end

#list(params: nil) ⇒ Hash

List payments

Retrieves a list of payments.

Parameters:

  • params (Hash, nil) (defaults to: nil) —

    Query parameters

Returns:

  • (Hash) —

    Response data



20
21
22
23
 
# File 'lib/billingrails/resources/payments.rb', line 20

def list(params: nil)
  path = "/payments"
  @client.request(:get, path, params: params)
end

#retrieve(id, params: nil) ⇒ Hash

Retrieve payment

Retrieves a payment by ID.

Parameters:

  • id (String) —

    Resource ID

  • params (Hash, nil) (defaults to: nil) —

    Query parameters

Returns:

  • (Hash) —

    Response data



43
44
45
46
 
# File 'lib/billingrails/resources/payments.rb', line 43

def retrieve(id, params: nil)
  path = "/payments/#{id}"
  @client.request(:get, path, params: params)
end