Module: Vindi::Rest::Transaction

Included in:
Vindi::Rest
Defined in:
lib/vindi/rest/transaction.rb

Overview

Methods for the Transaction API

See Also:

Instance Method Summary collapse

Instance Method Details

#create_transaction(options = {}) ⇒ Hash

Create a transaction for a merchant vindi

Examples:

Create a transaction for a merchant vindi

client.create_transaction(charge_id: 475, amount: 100,
                          payment_method_code: 'cash',
                          paid_at: "2017-09-08")

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :options (Hash) —

    transaction attributes

Returns:

  • (Hash) —

    The transaction created

See Also:



37
38
39
 
# File 'lib/vindi/rest/transaction.rb', line 37

def create_transaction(options = {})
  post('transactions', options)[:transaction]
end

#list_transactions(options = {}) ⇒ Array<Hash>

List transactions for the authenticate user

Examples:

Get all transactions from merchant vindi

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :page (Integer) — default: 1 —

    Page number.

  • :merchant (Integer) —

    Merchant account

Returns:

  • (Array<Hash>) —

    A list of transactions for a merchant.



13
14
15
 
# File 'lib/vindi/rest/transaction.rb', line 13

def list_transactions(options = {})
  get('transactions', options)[:transactions]
end

#transaction(transaction_id, options = {}) ⇒ Hash

Get a single transaction from a merchant

Examples:

Get transaction #2 from vindi

client.transaction(2)

Parameters:

  • transaction_id (Integer) —

    ID of the transaction

Returns:

  • (Hash) —

    The transaction you requested, if it exists

See Also:



24
25
26
 
# File 'lib/vindi/rest/transaction.rb', line 24

def transaction(transaction_id, options = {})
  get("transactions/#{transaction_id}", options)[:transaction]
end

#update_transaction(transaction_id, options = {}) ⇒ Object

Edit a transaction

Examples:

Update transaction #2

client.update_transaction(2, gateway_transaction_id: "gateway-transaction_id")

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :options (Hash) —

    transaction attributes

See Also:



48
49
50
 
# File 'lib/vindi/rest/transaction.rb', line 48

def update_transaction(transaction_id, options = {})
  put("transactions/#{transaction_id}", options)[:transaction]
end