Ramp.Transactions (ramp v1.0.0)

The Transactions resource: listing, retrieving, and updating (memo, accounting fields, policy feedback) card transactions.

Summary

Types

accounting_field_update()

list_opt()

policy_feedback()

update_opt()

Functions

get(client, txn_id)

Fetches a single transaction by ID.

list(client, opts \\ [])

Returns a lazily auto-paginating Stream of Ramp.Transactions.Transactions.

list_page(client, opts \\ [])

Fetches a single page of transactions. See Ramp.Page.

update(client, txn_id, opts)

Updates a transaction's memo, accounting field coding, and/or policy violation feedback (dispute or confirm a flagged policy violation).

Types

accounting_field_update()

@type accounting_field_update() :: %{
  :field_id => String.t(),
  optional(:external_id) => String.t(),
  optional(:option_id) => String.t()
}

list_opt()

@type list_opt() ::
  {:start, String.t()}
  | {:page_size, pos_integer()}
  | {:user_id, String.t()}
  | {:card_id, String.t()}
  | {:sync_status, String.t()}
  | {:merchant_id, String.t()}
  | {:sk_category_id, String.t()}
  | {:from_date, DateTime.t()}
  | {:to_date, DateTime.t()}
  | {:updated_after, DateTime.t()}
  | {:state, String.t()}
  | {:entity_id, String.t()}
  | {:order_by_date_asc, boolean()}

policy_feedback()

@type policy_feedback() :: %{policy_id: String.t(), flagged: boolean()}

update_opt()

@type update_opt() ::
  {:memo, String.t()}
  | {:accounting_fields, [accounting_field_update()]}
  | {:policy_feedback, [policy_feedback()]}

Functions

get(client, txn_id)

@spec get(Ramp.Client.t(), String.t()) ::
  {:ok, Ramp.Transactions.Transaction.t()} | {:error, Ramp.Error.t()}

Fetches a single transaction by ID.

list(client, opts \\ [])

@spec list(Ramp.Client.t(), [list_opt()]) ::
  Enumerable.t(Ramp.Transactions.Transaction.t())

Returns a lazily auto-paginating Stream of Ramp.Transactions.Transactions.

list_page(client, opts \\ [])

@spec list_page(Ramp.Client.t(), [list_opt()]) ::
  {:ok, Ramp.Page.t(Ramp.Transactions.Transaction.t())}
  | {:error, Ramp.Error.t()}

Fetches a single page of transactions. See Ramp.Page.

update(client, txn_id, opts)

@spec update(Ramp.Client.t(), String.t(), [update_opt()]) ::
  {:ok, Ramp.Transactions.Transaction.t()} | {:error, Ramp.Error.t()}

Updates a transaction's memo, accounting field coding, and/or policy violation feedback (dispute or confirm a flagged policy violation).