View Source ExChargebee.Transaction (ex_chargebee v0.4.5)

An interface for Interacting with transactions

For More information see Chargebee transaction Documentation

Summary

Functions

create_authorization(params, opts \\ [])

Perform a transaction create_authorization.

delete_offline_transaction(resource_id, params \\ %{}, opts \\ [])

Perform a delete_offline_transaction on individual transaction.

list(params \\ %{}, opts \\ [])

Returns a list of transactions. Pagination is handled automatically unless the opt paginate is set to false.

operations()
operations(group)
record_refund(resource_id, params \\ %{}, opts \\ [])

Perform a record_refund on individual transaction.

refund(resource_id, params \\ %{}, opts \\ [])

Perform a refund on individual transaction.

retrieve(resource_id, opts \\ [])
stream_list(params \\ %{}, opts \\ [])

Returns a stream of transactions. Pagination is handled automatically as the stream is consumed.

void(resource_id, params \\ %{}, opts \\ [])

Perform a void on individual transaction.

Functions

Link to this function

create_authorization(params, opts \\ [])

View Source 
@spec create_authorization(
  map(),
  keyword()
) :: map() | nil

Perform a transaction create_authorization.

Find more information in the Chargebee Documentation

Link to this function

delete_offline_transaction(resource_id, params \\ %{}, opts \\ [])

View Source 
@spec delete_offline_transaction(String.t(), map(), keyword()) :: map() | nil

Perform a delete_offline_transaction on individual transaction.

Find more information in the Chargebee Documentation

Link to this function

list(params \\ %{}, opts \\ [])

View Source 
@spec list(
  map(),
  keyword()
) :: [map()] | nil

Returns a list of transactions. Pagination is handled automatically unless the opt paginate is set to false.

opts:

  • site: the site to use for the request. Defaults to the default site.
  • paginate: whether to paginate the results. Defaults to false. If false, all results will be returned.
Link to this function

operations()

View Source 
@spec operations() :: Keyword.t()
Link to this function

operations(group)

View Source
Link to this function

record_refund(resource_id, params \\ %{}, opts \\ [])

View Source 
@spec record_refund(String.t(), map(), keyword()) :: map() | nil

Perform a record_refund on individual transaction.

Find more information in the Chargebee Documentation

Link to this function

refund(resource_id, params \\ %{}, opts \\ [])

View Source 
@spec refund(String.t(), map(), keyword()) :: map() | nil

Perform a refund on individual transaction.

Find more information in the Chargebee Documentation

Link to this function

retrieve(resource_id, opts \\ [])

View Source 
@spec retrieve(
  String.t(),
  keyword()
) :: map() | nil
Link to this function

stream_list(params \\ %{}, opts \\ [])

View Source 
@spec stream_list(
  map(),
  keyword()
) :: Enumerable.t()

Returns a stream of transactions. Pagination is handled automatically as the stream is consumed.

Link to this function

void(resource_id, params \\ %{}, opts \\ [])

View Source 
@spec void(String.t(), map(), keyword()) :: map() | nil

Perform a void on individual transaction.

Find more information in the Chargebee Documentation