omise
v0.10.0

Omise.Transaction (omise v0.10.0)

Provides Transaction API interfaces.

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

Summary

Types

t()

Functions

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

List all transactions.

retrieve(id, opts \\ [])

Retrieve a transaction.

Types

Link to this type

t()

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

Functions

Link to this function

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

@spec 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)
Link to this function

retrieve(id, opts \\ [])

@spec 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")