omise v0.6.0 Omise.Transaction

Provides Transaction API interfaces.

https://www.omise.co/transactions-api

Link to this section Summary

Types

t()

Functions

list(params \\ [], opts \\ [])

List all transactions

retrieve(id, opts \\ [])

Retrieve a transaction

Link to this section Types

t()

t() :: %Omise.Transaction{amount: integer(), created: String.t(), currency: String.t(), id: String.t(), location: String.t(), object: String.t(), source: String.t(), transferable: String.t(), type: String.t()}

Link to this section Functions

list(params \\ [], opts \\ [])

list(Keyword.t(), Keyword.t()) ::
  {:ok, Omise.List.t()} |
  {:error, Omise.Error.t()}

List all transactions.

Returns {:ok, transactions} if the request is successful, {:error, error} otherwise.

Query Parameters:

offset - (optional, default: 0) The offset of the first record returned.
limit - (optional, default: 20, maximum: 100) The maximum amount of records returned.
from - (optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records.
to - (optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records.

Examples

Omise.Transaction.list

Omise.Transaction.list(limit: 5)

retrieve(id, opts \\ [])

retrieve(String.t(), Keyword.t()) ::
  {:ok, t()} |
  {:error, Omise.Error.t()}

Retrieve a transaction.

Returns {:ok, transaction} if the request is successful, {:error, error} otherwise.

Examples

Omise.Transaction.retrieve("trxn_test_51yg3xs2yggzsfbai3e")