Previous topic

Deposits

Next topic

All Models

This Page

Transactions

class fattmerchant.controllers.transactions.TransactionsController(request)

Class interface with transactions within the Fattmerchant API

list(options={})

Gets a list of transactions from the API

Parameters:options (dict) –

A dictionary with any optional query params

{
    "per_page": 10,
    "page": 1
}
Returns:A list of transaction objects
Return type:Transaction
get(id=None)

Gets a single transaction’s details from the API

Parameters:id (string) – A transaction ID
Returns:A single transaction object
Return type:Transaction
Raises:InvalidRequestDataException – Raised if id is not provided
refund(id=None, amount=None)

Refund a certain amount of a transaction

Parameters:
  • id (string) – A transaction ID
  • amount (int|float) – The amount to be refunded
Returns:

A single transaction object

Return type:

Transaction

Raises:

InvalidRequestDataException – Raised if id is not provided and if amount is not provided